From f7f55e634dac6e60e25599e45cfbcff06a3ae5a2 Mon Sep 17 00:00:00 2001
From: Hu Zhao <zhao@mbd.rwth-aachen.de>
Date: Tue, 13 Dec 2022 15:32:07 +0100
Subject: [PATCH] docs: add documentation for run_simulator

---
 docs/source/simulator/run_simulator.rst | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/docs/source/simulator/run_simulator.rst b/docs/source/simulator/run_simulator.rst
index 95efe48..5a24b32 100644
--- a/docs/source/simulator/run_simulator.rst
+++ b/docs/source/simulator/run_simulator.rst
@@ -1,6 +1,17 @@
 Run Simulator
 =============
 
+A `simulator` which describes certain real-world system is often subject to
+uncertainties. Uncertainty-related analyses require running the `simulator`
+multiple times at different variable input points. Class :class:`.RunSimulator`
+implemented in this module provides functionality to sequentially or parallelly
+execute `simulator` at a number of varaible input points.
+
+The user needs to define their `simulator`, implement an interface (essentially
+a Python function) to call the `simulator` from within Python and return output
+of interest, and inform :class:`.RunSimulator` the signature of the interface.
+
+
 RunSimulator Class
 ------------------
 
-- 
GitLab