Doc: Update RTD landing page (#105)

* Doc: Update RTD landing page Add a bit of content. #95. * Apply suggestions from code review Co-authored-by: Dilan Pathirana <[email protected]> * Formatting, spelling, links --------- Co-authored-by: Dilan Pathirana <[email protected]>
PEtab-dev · Nov 12, 2024 · ec9a5a6 · ec9a5a6
1 parent 118fab5
commit ec9a5a6
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 3 deletions.
diff --git 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
@@ -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 <https://en.wikipedia.org/wiki/Model_selection>`_ to
+`PEtab <https://petab.readthedocs.io/>`_. 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 <https://en.wikipedia.org/wiki/Stepwise_regression#Main_approaches>`_
+* `backward selection <https://en.wikipedia.org/wiki/Stepwise_regression#Main_approaches>`_
+* `FAMoS <https://doi.org/10.1371/journal.pcbi.1007230>`_
+
+Supported model selection criteria:
+
+* (`corrected <https://en.wikipedia.org/wiki/Akaike_information_criterion#Modification_for_small_sample_size>`_)
+  `Akaike Information Criterion <https://en.wikipedia.org/wiki/Akaike_information_criterion#Definition>`_ (AIC / AICc)
+* `Bayesian Information Criterion <https://en.wikipedia.org/wiki/Bayesian_information_criterion#Definition>`_ (BIC)
+
+Model calibration is performed outside of PEtab Select. For example,
+PEtab Select is well-integrated with:
+
+* `BasiCO <https://basico.readthedocs.io/>`_
+  (`example <https://basico.readthedocs.io/en/latest/notebooks/Working_with_PEtab.html#Model-Selection>`_)
+* `PEtab.jl <https://sebapersson.github.io/PEtab.jl>`_
+  (`example <https://sebapersson.github.io/PEtab.jl/stable/pest_select/>`_)
+* `pyPESTO <https://pypesto.readthedocs.io/>`_
+  (`example <https://pypesto.readthedocs.io/en/latest/example/model_selection.html>`_)
+
+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 <test_suite>
    api
-   problem_definition
 
 
 Indices and tables