Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dev #46

Merged
merged 2 commits into from
Oct 24, 2023
Merged

Dev #46

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/_static/usage/example1.JPG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 25 additions & 4 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,31 @@ The :file:`yaml` configuration file contains all parameters required to calculat
thus key to ensure **reproducibility** of the flux calculation process. A configuration file is generated automatically by
PhysioFit during flux calculation; it can also be created or edited manually.

Here is an example of a configuration file:

.. image:: _static/usage/config_example.JPG
:scale: 80%
Here is an example of a configuration file: ::

iterations: 100
mc: true
model:
bounds:
Ace_M0: (1e-06, 50)
Ace_q: (-50, 50)
Glc_M0: (1e-06, 50)
Glc_q: (-50, 50)
X_0: (0.001, 10)
growth_rate: (0.001, 3)
model_name: Steady-state batch model
parameters_to_estimate:
Ace_M0: 1
Ace_q: 1
Glc_M0: 1
Glc_q: 1
X_0: 1
growth_rate: 1
path_to_data: ..\data\test-data_single_exp.tsv
sds:
Ace: 0.2
Glc: 0.2
X: 0.2

For a description of all calculation parameters, check the section below.

Expand Down