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”.

main_modules
- reaction_set
- reaction_model

Calculation Tools¶

Several, more general, calculation methods are located here.

calculation_tools

Estimability Tools¶

Tools for analyzing parameters are found here.

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.

estimator_tools

Settings¶

General settings for KIPET are stored here.

general_settings

Input/Output¶

Input and output methods specific to KIPET.

input_output

Mixins¶

Mixin classes used in other parts of KIPET

mixins
- parameter_estimator_mixins
- wavelength_mixins

Model Components¶

Methods and classes used in building the models used in KIPET

model_components

Model Tools¶

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

model_tools

Variance Methods¶

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

variance_methods

Visuals¶

Plotting tools

visuals
- plots
- reports