diff --git a/doc/conf.py b/doc/conf.py index 51ae4d36..c38a7c30 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -8,7 +8,7 @@ # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information -project = 'petab-select' +project = 'PEtab Select' copyright = '2023, The PEtab Select developers' author = 'The PEtab Select developers' diff --git a/doc/index.rst b/doc/index.rst index 62c081a6..8cefeba6 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -3,17 +3,64 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to petab-select's documentation! +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 of 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 / AICc) +* `Bayesian Information Criterion `_ (BIC) + +Model calibration is performed outside of PEtab Select. For example, +PEtab Select is well-integrated with: + +* `BasiCO `_ + (`example `_) +* `PEtab.jl `_ + (`example `_) +* `pyPESTO `_ + (`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