From 16ee5d52f8665f53611e8c58738f25f21bad7ab7 Mon Sep 17 00:00:00 2001
From: Hu Zhao <zhao@mbd.rwth-aachen.de>
Date: Sun, 16 Apr 2023 09:09:17 +0200
Subject: [PATCH] docs: add description for sobol analysis
---
docs/source/sensitivity/index.rst | 4 ++--
docs/source/sensitivity/sobol.rst | 9 +++++++--
2 files changed, 9 insertions(+), 4 deletions(-)
diff --git a/docs/source/sensitivity/index.rst b/docs/source/sensitivity/index.rst
index 5e60a0a..75d67ed 100644
--- a/docs/source/sensitivity/index.rst
+++ b/docs/source/sensitivity/index.rst
@@ -2,11 +2,11 @@
Sensitivity
***********
-This module hosts functionality for methods of sensitivity analysis.
+This module hosts functionality for sensitivity analysis methods.
Currently implemented classes are:
-* :class:`.SobolAnalyze`:
+* :class:`.SobolAnalyze`: Compute Sobol' sensitivity indices.
.. toctree::
:maxdepth: 1
diff --git a/docs/source/sensitivity/sobol.rst b/docs/source/sensitivity/sobol.rst
index 7c59f92..b140e4d 100644
--- a/docs/source/sensitivity/sobol.rst
+++ b/docs/source/sensitivity/sobol.rst
@@ -1,5 +1,10 @@
-Sobol' Sensitivity Analyze
-==========================
+Sobol' Sensitivity Analysis
+===========================
+
+This module is used to compute Sobol' indices given model (e.g. simulator or emulator)
+outputs evaluated at chosen Saltelli samples (see the :class:`.Saltelli` class).
+Detailed description of the theory can be found in :cite:t:`Saltelli2002` and :cite:t:`Saltelli2010`.
+The :class:`.SobolAnalyze` class relies on the Python package `SALib` :cite:p:`Herman2017`.
SobolAnalyze Class
------------------
--
GitLab