API Reference
=============

The basic object hierarchy of PathSim is shown in the diagramm below. The :class:`.Simulation` manages the system components (derivatives of :class:`.Block` and :class:`.Event`, :class:`.Connection`). 

.. image:: figures/pathsim_object_hierarchy.png
   :width: 700
   :align: center
   :alt: hierarchy of PathSim objects


System Definition and Simulation
--------------------------------

The following modules serve the system definition and simulation. In PathSim, systems are defined by instantiating blocks from the block library :mod:`.blocks` and connecting them using :class:`.Connection` objects. PathSim also supports hierarchical modling through subsystems with the :class:`.Subsystem` class, which holds internal blocks and connections and behaves just like a normal block from the outside.


.. toctree::
   :maxdepth: 3
   :caption: Simulation

   modules/pathsim.simulation
   
.. toctree::
   :maxdepth: 3
   :caption: Subsystem (hierarchical modeling)

   modules/pathsim.subsystem
   
.. toctree::
   :maxdepth: 3
   :caption: Connection 

   modules/pathsim.connection
   
.. toctree::
   :maxdepth: 5
   :caption: Block Library

   modules/pathsim.blocks

.. toctree::
   :maxdepth: 5
   :caption: Event Library

   modules/pathsim.events



ODE Solvers
-----------

The numerical ODE solvers, available in PathSim are structured like this:

.. image:: figures/pathsim_solver_hierarchy.png
   :width: 700
   :align: center
   :alt: hierarchy of PathSim numerical integrators


.. toctree::
   :maxdepth: 4
   :caption: Solvers

   modules/pathsim.solvers



Optimizers and Automatic Differentiation
----------------------------------------

The :mod:`.optim` module contains a range of nonlinear solvers / optimizers that are primarily used for the implicit update equation of implicit ODE solvers and for the steadystate solver. This module also includes the automatic differentiation framework.

.. toctree::
   :maxdepth: 4
   :caption: Optim

   modules/pathsim.optim


Utilities
---------

Utility functions and classes.

.. toctree::
   :maxdepth: 4
   :caption: Utils

   modules/pathsim.utils