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

The following **clickable** scheme present the structure of the proposed package. Note that each class can be used independently for a custom purpose. In addition of providing simulation function, classes provides some usefull features. For instance, the CompartmentModel class include a method to compute the gain of the linear dynamical system or the patient class a class to initialize the patient at a non-zero equilibrium state.

.. raw:: html

   <object data="_static/API_scheme.svg" type="image/svg+xml" width="100%" height="600px"></object>



.. toctree::
   :maxdepth: 2

   Simulator <simulator>
   Patient <patient>
   PK Models <pk_models>
   PD Models <pd_models>
   TCI Controller <tci_control>
   Disturbances <disturbances>
   Metrics <metrics>
   Alarms <alarms>