.. Akantu documentation master file, created by
   sphinx-quickstart on Fri Apr 17 16:35:46 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Akantu: a FEM library
=====================

|license| |joss|

.. |joss| image:: https://joss.theoj.org/papers/3abf3c7945cc9a016a946ce9e02e357f/status.svg
   :target: https://joss.theoj.org/papers/3abf3c7945cc9a016a946ce9e02e357f

.. |license| image:: https://img.shields.io/badge/license-LGPLv3-green
   :target: https://www.gnu.org/licenses/lgpl-3.0.en.html

**Akantu** means a little element in *Kinyarwanda*, a Bantu language. From now
on it is also an opensource object-oriented *Finite-Element* library which has
the ambition to be generic and efficient. **Akantu** is developed within the
`LSMS <https://lsms.epfl.ch>`_ (Computational Solid Mechanics Laboratory)*, where
research is conducted at the interface of mechanics, material science, and
scientific computing. The open-source philosophy is important for any scientific
software project evolution. The collaboration permitted by shared codes enforces
sanity when users (and not only developers) can criticize the implementation
details. Akantu was born with the vision to associate genericity, robustness and
efficiency while benefiting the open-source visibility.

.. toctree::
   :maxdepth: 2
   :caption: User Manual

   ./manual/getting_started.rst
   ./manual/basic_types.rst
   ./manual/models.rst
   ./manual/io.rst

.. toctree::
   :maxdepth: 2
   :caption: Cite Akantu

   ./manual/cite-akantu.rst

.. toctree::
   :maxdepth: 1
   :caption: Examples & Tutorials

   ./examples.rst
   ./tutorials.rst

.. toctree::
   :maxdepth: 1
   :caption: Changelog

   ./changelog.md

.. toctree::
   :maxdepth: 2
   :caption: API Reference

   ./reference.rst

.. toctree::
   :maxdepth: 1
   :caption: Appendix

   ./manual/appendix.rst

.. toctree::
   :maxdepth: 2
   :caption: Bibliography

   ./manual/bibliography.rst

.. toctree::
   :maxdepth: 1
   :caption: Indices and tables

   ./manual/extra.rst