ECOGEN's documentation
======================

Here is described the documentation of the ECOGEN_ open-source plateform dedicated to numerical simulation of compressible multiphase flows.

ECOGEN is an open-source project distributed under `GNU GPLv3 License`_ and available on `GitHub`_.

It is developed by code-mphi members in partnership with AMU_, Caltech_ and CNES_.

In this document, ECOGEN's user will find all necessary information to use the software.

Interested developers are encouraged to contribute in the project using the "pull request" feature on `GitHub`_ and can use the API documentation generated by Doxygen_.


.. _`GitHub`: https://github.com/code-mphi/ECOGEN
.. _ECOGEN: https://code-mphi.github.io/ECOGEN/
.. _`GNU GPLv3 License`: http://www.gnu.org/licenses
.. _AMU: https://www.univ-amu.fr/
.. _Caltech: http://www.mce.caltech.edu/
.. _CNES: https://cnes.fr/fr
.. _Doxygen: https://code-mphi.github.io/ECOGEN/docs/doxygen_docs/index.html

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   Chap1_introduction
   Chap2_installation_Chapter
   Chap3_IO_Chapter
   Chap4_tutorials_Chapter
   Chap5_testCases_Chapter
   Chap6_developersGuide_Chapter
   Chap7_license
   zBibliography


Table of contents
=================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`