From 56f16d926a06649f678f940cb4a87e956c683358 Mon Sep 17 00:00:00 2001 From: Daniel Weindl Date: Tue, 12 Nov 2024 13:24:18 +0100 Subject: [PATCH] Doc: Update RTD landing page Add a bit of content. #95. --- doc/index.rst | 43 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 42 insertions(+), 1 deletion(-) diff --git a/doc/index.rst b/doc/index.rst index 62c081a6..827e9524 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -6,14 +6,55 @@ Welcome to petab-select's documentation! ======================================== +PEtab Select brings +`model selection `_ to +`PEtab `_. PEtab Select comprises file +formats, a Python library and a command line interface. + +Model selection is the process of choosing the best model from a set of +candidate models. PEtab Select provides a standardized and compact way to +specify the candidate model space, implements a number model selection +algorithms and criteria. + +Supported model selection algorithms: + +* brute force +* forward selection +* backward selection +* FAMoS + +Supported model selection criteria: + +* (corrected) Akaike Information Criterion (AIC / cAIC) +* Bayesian Information Criterion (BIC) +* ... + +Model calibration is performed outside of PEtab Select. For example, +PEtab Select is well-integrated with +`pypesto `_ +(`model selection example `_). +Other model calibration tools can easily be integrated using the provided +Python library or command line interface. + +Installation +------------ + +The Python 3 package provides both the Python 3 and command-line (CLI) +interfaces, and can be installed from PyPI, with + +.. code-block:: bash + + pip install petab-select + + .. toctree:: :maxdepth: 2 :caption: Contents: + problem_definition examples Test Suite api - problem_definition Indices and tables