.. bayesvalidrox documentation master file, created by
   sphinx-quickstart on Wed Dec 13 11:14:59 2023.
   
Surrogate-assisted Bayesian validation of computational models
==============================================================
**BayesValidRox** is an open-source python package that provides methods for surrogate modeling, Bayesian inference and model comparison.

.. image:: ../diagrams/balance.png
   :width: 600
   :alt: Weighting model results against data with associated uncertainty, costs and sparsity
   
An introductory tutorial to the overall workflow with **bayesvalidrox** is provided in :any:`tutorial` and descriptions of the available examples can be found in :any:`examples`.
The functionality and options for the different classes is described more in-depth in :any:`packagedescription` and a list of all the classes and functions is provided in :any:`api`.

Links
-----
* GitHub: https://git.iws.uni-stuttgart.de/inversemodeling/bayesvalidrox/-/tree/master?ref_type=heads
* PyPI: https://pypi.org/project/bayesvalidrox/
* Documentation:


Installation
------------
This package runs under Python 3.9 for versions <1.0.0 and 3.9+ from version 1.0.0 on, use pip to install:

.. code-block:: bash

   pip install bayesvalidrox


Quickstart
----------
#TODO A minimal example to get people started

License
-------
#TODO Note the License under which BVR is released

Contribution
------------
We would be happy for you to contribute to **BayesValidRox**.
This can include e.g. reporting issues, proposing new features, working on features, or support with the documentation.
If you want to contibute, check out our contribution_ guidelines.
You can contact us on the gitlab_ page.

.. _gitlab: https://git.iws.uni-stuttgart.de/inversemodeling/bayesvalidrox

.. _contribution: https://git.iws.uni-stuttgart.de/inversemodeling/bayesvalidrox/-/blob/docs/sphinx_new/CONTRIBUTING.md?ref_type=heads

Further contents
----------------

.. toctree::
   :maxdepth: 1
   
   packagedescription
   tutorial
   examples
   api

   
Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`