Customized webpage design using sphinx.

Webpage includes quickstart, user guide, tutorial, example collection and api.
One new example was added for the user guide.

docs/build/html/_sources/index.rst.txt

 .. bayesvalidrox documentation master file, created by
    sphinx-quickstart on Wed Dec 13 11:14:59 2023.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
+   
 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.
-
+**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:
+
+#TODO Add other links
 
-Contents
+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:
+ $ pip install bayesvalidrox
+
+#TODO Note other needed installations and tips
+
+Quickstart
+----------
+#TODO A minimal example to get people started
+
+See also
 --------
+#TODO Link other websites that are related to BVR
+
+License
+-------
+#TODO Note the License under which BVR is released
+
+Further contents
+----------------
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
    
    tutorial
    examples

docs/build/html/_sources/packagedescription.rst.txt

-PACKAGE DESCRIPTION
-*******************
-The package **bayesvalidrox** is split into multiple topics corresponding to the folder structure of the package.
-The folder `surrogate_models` contains all the functions and classes to set up the experimental design with priors and create and train the surrogate model.
-The computational model is linked via *pylink*.
-Postprocessing, Bayesian inference and Bayesian model comparison each also get their own section.
+USER GUIDE
+**********
 
+Introductory theory
+===================
+.. note::
+   #TODO Introduced some of the used basic terms and notations here to prepare for the detailed descriptions of each part.
 
-TODO: add image to show folder/file interconnection
 
-Priors, experimental design and surrogates
-==========================================
-The package **bayesvalidrox** 
+Overview
+========
+This package is split into multiple topics corresponding to the folder structure of the package.
+
+
+.. image:: ../diagrams/folder_structure.png
+   :width: 600
+   :alt: Folder structure of **bayesvalidrox**
+
+The folder `surrogate_models` contains all the functions and classes that are necessary in order to create and train the surrogate model.
+This includes 
+
+* defining the input marginals
+* setting properties of the sampling in an experimental design
+* choosing the surrogate model and its properties
+* training the surrogate model on model evaluations in a straightforward or iterative manner
+
+The computational model is linked via a *pylink* interface.
+We split this into the aspects :any:`input_description` and :any:`surrogate_description` to provide insight into the options available in bayesvalidrox.
+
+:any:`post_description` can be applied to trained surrogate models, or using the underlying models themselves.
+
+
+.. toctree::
+   :maxdepth: 1
+   
+   input_description
+   surrogate_description
+   post_description

docs/build/html/_sources/post_description.rst.txt

+Postprocessing, Bayesian inference and Bayesian model comparison
+****************************************************************
\ No newline at end of file

docs/build/html/_sources/surrogate_description.rst.txt

+Training surrogate models
+*************************
\ No newline at end of file

docs/build/html/_static/custom.css

-/* This file intentionally left blank. */
+div.leftside {
+    width: 60%;
+    padding: 0px 3px 0px 0px;
+    float: left;
+}
+
+div.rightside {
+    margin-left: 62%;
+}
\ No newline at end of file

docs/build/html/_static/documentation_options.js

 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.0.5',
+    VERSION: '1.0.0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',
@@ -7,7 +7,7 @@ const DOCUMENTATION_OPTIONS = {
     LINK_SUFFIX: '.html',
     HAS_SOURCE: true,
     SOURCELINK_SUFFIX: '.txt',
-    NAVIGATION_WITH_KEYS: false,
+    NAVIGATION_WITH_KEYS: true,
     SHOW_SEARCH_SUMMARY: true,
     ENABLE_SEARCH_SHORTCUTS: true,
 };
\ No newline at end of file