code.rst

Code Documentation

All of the public classes and methods used in KIPET are listed on these pages.

Users should generally only be interested in the modules and classes found in Main modules.

Developers may find the other modules and classes of interest.

Main modules

The two modules that will actually be used by the user are found here. They are initialized automatically and can be imported directly from "kipet".

.. toctree::
   :maxdepth: 2

   modules/main_modules

Calculation Tools

Several, more general, calculation methods are located here.

.. toctree::
   :maxdepth: 2

   modules/calculation_tools

Estimability Tools

Tools for analyzing parameters are found here.

.. toctree::
   :maxdepth: 2

   modules/estimability_tools

Estimator Tools

The main estimation modules and classes are found here alongside several helper modules. The core methods for variance estimation and parameter fitting (VarianceEstimator and ParameterEstimator classes) are found here.

.. toctree::
   :maxdepth: 2

   modules/estimator_tools

Settings

General settings for KIPET are stored here.

.. toctree::
   :maxdepth: 2

   modules/general_settings

Input/Output

Input and output methods specific to KIPET.

.. toctree::
   :maxdepth: 2

   modules/input_output

Mixins

Mixin classes used in other parts of KIPET

.. toctree::
   :maxdepth: 2

   modules/mixins

Model Components

Methods and classes used in building the models used in KIPET

.. toctree::
   :maxdepth: 2

   modules/model_components

Model Tools

Methods and classes used in performing various tasks on the models used in KIPET

.. toctree::
   :maxdepth: 2

   modules/model_tools

Variance Methods

Core methods used to estimate the variances taken from the literature.

.. toctree::
   :maxdepth: 2

   modules/variance_methods

Visuals

Plotting tools

.. toctree::
   :maxdepth: 2

   modules/visuals