Skip to content

Commit 583e3ab

Browse files
committed
explain user and developer notebooks
1 parent 5085b7c commit 583e3ab

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

doc/examples.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,19 @@
11
Examples
22
========
33

4-
Various example notebooks.
4+
There are currently notebooks aimed at users and developers.
5+
6+
Users that are working with PEtab problems should consult the model selection documentation of the calibration tool they wish to use. In this case, there is no need to use the PEtab Select package directly to perform model selection. After model selection, results can be analyzed with PEtab Select. See the API documentation for :mod:`petab_select.analyze`, or the visualization notebook.
7+
8+
Users who wish to apply model selection methods using a calibration tool that doesn't support PEtab can refer to the "other_model_types" notebook for a demonstration using statsmodels.
9+
10+
Developers wishing to implement model selection in their tool via PEtab Select can consult the workflow or "example_cli_famos" notebooks.
511

612
.. toctree::
713
:maxdepth: 1
814

9-
examples/example_cli_famos.ipynb
1015
examples/visualization.ipynb
16+
examples/other_model_types.ipynb
17+
examples/example_cli_famos.ipynb
1118
examples/workflow_cli.ipynb
1219
examples/workflow_python.ipynb

0 commit comments

Comments
 (0)