===================
Welcome to FAST-OAD
===================

For a **quick overview** of the way FAST-OAD works, please go :ref:`here<overview>`.

**Installation instructions** are :ref:`here <installation-procedure>`.

For a detailed description of the **input files and the Command Line Interface**,
check out the :ref:`usage section<usage>`.

If you prefer to discover the **Application Programming Interface with Python notebooks**,
you may go directly to the section :ref:`python-usage`.

For a description of **models used in FAST-OAD**, you may see the
:ref:`model documentations<fastoad.models package>`.

If you want to **add your own models**, please check out :ref:`add-modules`.

.. note::

    Since version 1.3, FAST-OAD has its core features in
    `FAST-OAD-core <https://pypi.org/project/fast-oad-core/>`_ package, while the legacy
    models are in `FAST-OAD-CS25 <https://pypi.org/project/fast-oad-cs25/>`_ package.

    Yet, installing FAST-OAD 1.x will keep installing both FAST-OAD-core and FAST-OAD-CS25.

    Models in FAST-OAD-CS25 are still a work in progress.



Contents
========

.. toctree::
   :maxdepth: 1

   License <license>
   Authors <authors>
   Citation <citation>
   Changelog <changelog>
   General documentation <documentation/index>
   API Reference <api/modules>


Indices and tables
==================

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

.. _toctree: http://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html
.. _reStructuredText: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
.. _references: http://www.sphinx-doc.org/en/stable/markup/inline.html
.. _Python domain syntax: http://sphinx-doc.org/domains.html#the-python-domain
.. _Sphinx: http://www.sphinx-doc.org/
.. _Python: http://docs.python.org/
.. _Numpy: http://docs.scipy.org/doc/numpy
.. _SciPy: http://docs.scipy.org/doc/scipy/reference/
.. _matplotlib: https://matplotlib.org/contents.html#
.. _Pandas: http://pandas.pydata.org/pandas-docs/stable
.. _Scikit-Learn: http://scikit-learn.org/stable
.. _autodoc: http://www.sphinx-doc.org/en/stable/ext/autodoc.html
.. _Google style: https://github.com/google/styleguide/blob/gh-pages/pyguide.md#38-comments-and-docstrings
.. _NumPy style: https://numpydoc.readthedocs.io/en/latest/format.html
.. _classical style: http://www.sphinx-doc.org/en/stable/domains.html#info-field-lists