=============
API reference
=============

This page describes the package and all the public Python objects.

Parameters classes (``nopec.parameters``)
-----------------------------------------

Parameters define the settings.

.. toctree::
   :hidden:

   modules/parameters/input
   modules/parameters/model
   modules/parameters/optimization

.. list-table:: Definition of different parameters

   * - :doc:`modules/parameters/model`
     - Parameters for the mathematical model and the finite element (FE) discretization.
   * - :doc:`modules/parameters/input`
     - Discretization of the input function.
   * - :doc:`modules/parameters/optimization`
     - Parameters for the optimization.

Models classes (``nopec.models``)
---------------------------------

.. autosummary::
   :toctree: _autosummary
   :nosignatures:
   :template: mixed_classes.rst

   nopec.models.fenics_model

Other submodules
----------------

.. autosummary::
   :toctree: _autosummary
   :nosignatures:

   nopec.tools