[create-pull-request] automated change

Author: paucablop

docs/ExtendedKalmanFilter.md

@@ -0,0 +1,37 @@
+# ExtendedKalmanFilter
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+measurement_covariance |  | 
+model_covariance |  | 
+
+
+
+
+
+### calculate
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+measurements |  | 
+
+
+
+

docs/MassBalance.md

@@ -0,0 +1,40 @@
+# MassBalance
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+microbial_kinetics |  | 
+inlet |  | 
+outlet |  | 
+
+
+
+
+
+### calculate
+
+
+Calculates the mass balance for a given kinetic rate list. 
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+concentrations |  | 
+time |  | 
+
+
+
+

docs/README.md

@@ -2,6 +2,12 @@
 
 ## Classes
 
+**[ExtendedKalmanFilter](ExtendedKalmanFilter.md)**: 
+
+**[YeastModel](YeastModel.md)**: 
+
+**[MassBalance](MassBalance.md)**: 
+
 **[RangeCut](RangeCut.md)**: Cuts a dataframe selecting the wavenumbers between start and end. 
 
 **[Derivative](Derivative.md)**: Calculates the derivative of a each row in a dataframe using the Savitzky-Golay filter. 
@@ -41,37 +47,53 @@ Test the loading of the fermentation data.
 
 
 
-### cross_validation
+### load_training_data
 
 
-Performs cross-validation on the data. By default it performs a leave-one-out cross-validation. 
-#### Parameters
-name | description | default
---- | --- | ---
-X | spectra dataframe containing the spectra with the wavenumbers as columns. | 
-y | dataframe containing the reference hplc measurements. | 
+Loads the training data. 
 
 
 
 
+### load_fermentation_spectra_data
 
-### load_train_data
 
-
-Loads the train data. 
+Loads the fermentation data. 
 
 
 
 
-### load_fermentation_data
+### load_fermentation_hplc_data
 
 
 Loads the fermentation data. 
 
 
 
 
-### plot_fermentation
+### load_pls_glucose_model
+
+
+
+
+
+
+
+### cross_validation
+
+
+Performs cross-validation on the data. By default it performs a leave-one-out cross-validation. 
+#### Parameters
+name | description | default
+--- | --- | ---
+X | spectra dataframe containing the spectra with the wavenumbers as columns. | 
+y | dataframe containing the reference hplc measurements. | 
+
+
+
+
+
+### plot_pls_fermentation
 
 
 Plots the predicted concentration and the reference hplc measurements. 
@@ -85,6 +107,20 @@ fermentation_hplc | load the reference hplc measurements. |
 
 
 
+### plot_pls_training
+
+
+Plots the PLS predictions and the reference hplc measurements for the training set. 
+#### Parameters
+name | description | default
+--- | --- | ---
+predictions | predicted concentrations. | 
+reference | reference hplc measurements. | 
+
+
+
+
+
 ### plot_spectra
 
 
@@ -101,15 +137,17 @@ ylabel | y-axis label |
 
 
 
-### plot_predictions
+### plot_mechanistic_fermentation
 
 
-Plots the PLS predictions and the reference hplc measurements for the training set. 
+Plots the predicted concentration and the reference hplc measurements. 
 #### Parameters
 name | description | default
 --- | --- | ---
-predictions | predicted concentrations. | 
-reference | reference hplc measurements. | 
+prediction | load the predictions. | 
+fermentation_hplc | load the reference hplc measurements. | 
+time |  | 
+concentrations |  | 
 
 
 

docs/YeastModel.md

@@ -0,0 +1,40 @@
+# YeastModel
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+model_type |  | 
+substrate_biomass_yield |  | 
+substrate_product_yield |  | 
+
+
+
+
+
+### calculate_rates
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+substrate_concentration |  | 
+biomass_concentration |  | 
+
+
+
+