Skip to content
Snippets Groups Projects
Commit 5666b3ae authored by Hu Zhao's avatar Hu Zhao
Browse files

docs: adjust punctuation characters for section headers

parent 92ff685e
Branches
No related tags found
No related merge requests found
Showing with 39 additions and 35 deletions
:gitlab_url: https://git-ce.rwth-aachen.de/mbd/psimpy
=======
Welcome
=======
......@@ -101,4 +100,5 @@ use :py:mod:`PSimPy`.
/sampler/index
/sensitivity/index
/simulator/index
changelog.rst
refs.rst
Active Learning
---------------
===============
ActiveLearning Class
^^^^^^^^^^^^^^^^^^^^
--------------------
The :class:`.ActiveLearning` class is imported by::
from psimpy.inference.active_learning import ActiveLearning
Methods
*******
^^^^^^^
.. autoclass:: psimpy.inference.active_learning.ActiveLearning
:members: initial_simulation, iterative_emulation, approx_ln_pxl
\ No newline at end of file
Bayes Inference
---------------
===============
GridEstimation Class
^^^^^^^^^^^^^^^^^^^^
--------------------
The :class:`.GridEstimation` class is imported by::
from psimpy.inference.bayes_inference import GridEstimation
Methods
*******
^^^^^^^
.. autoclass:: psimpy.inference.bayes_inference.GridEstimation
:members: run
MetropolisHastingsEstimation Class
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
----------------------------------
The :class:`.MetropolisHastingsEstimation` class is imported by::
from psimpy.inference.bayes_inference import MetropolisHastingsEstimation
Methods
*******
^^^^^^^
.. autoclass:: psimpy.inference.bayes_inference.MetropolisHastingsEstimation
:members: run
*********
Inference
=========
*********
This module hosts functionality for inference methods.
......
*******
Sampler
=======
*******
This module hosts functionality for sampling methods.
......
Latin Hypercube Sampling
------------------------
========================
LHS Class
^^^^^^^^^
---------
The :class:`.LHS` class is imported by::
from psimpy.sampler.latin import LHS
Methods
*******
^^^^^^^
.. autoclass:: psimpy.sampler.latin.LHS
:members: sample
\ No newline at end of file
Metropolis Hastings Sampling
----------------------------
============================
MetropolisHastings Class
^^^^^^^^^^^^^^^^^^^^^^^^
------------------------
The :class:`.MetropolisHastings` class is imported by::
from psimpy.sampler.metropolis_hastings import MetropolisHastings
Methods
*******
^^^^^^^
.. autoclass:: psimpy.sampler.metropolis_hastings.MetropolisHastings
:members: sample
\ No newline at end of file
Saltelli Sampling
-----------------
=================
Saltelli Class
^^^^^^^^^^^^^^
--------------
The :class:`.Saltelli` class is imported by::
from psimpy.sampler.saltelli import Saltelli
Methods
*******
^^^^^^^
.. autoclass:: psimpy.sampler.saltelli.Saltelli
:members: sample
\ No newline at end of file
***********
Sensitivity
===========
***********
This module hosts functionality for methods of sensitivity analysis.
......
Sobol' Sensitivity Analyze
--------------------------
==========================
SobolAnalyze Class
^^^^^^^^^^^^^^^^^^
------------------
The :class:`.SobolAnalyze` class is imported by::
from psimpy.sensitivity.sobol import SobolAnalyze
Methods
*******
^^^^^^^
.. autoclass:: psimpy.sensitivity.sobol.SobolAnalyze
:members: run
\ No newline at end of file
*********
Simulator
=========
*********
This module hosts functionality for running simulators, as well as some
simulators used in the landslide community.
......
Mass Point Model
----------------
================
MassPointModel Class
^^^^^^^^^^^^^^^^^^^^
--------------------
The :class:`.MassPointModel` class is imported by::
from psimpy.simulator.mass_point_model import MassPointModel
Methods
*******
^^^^^^^
.. autoclass:: psimpy.simulator.mass_point_model.MassPointModel
:members: run
\ No newline at end of file
Ravaflow24 Mixture Model
------------------------
========================
Ravaflow24Mixture Class
^^^^^^^^^^^^^^^^^^^^^^^
-----------------------
The :class:`.Ravaflow24Mixture` class is imported by::
from psimpy.simulator.ravaflow24 import Ravaflow24Mixture
Methods
*******
^^^^^^^
.. autoclass:: psimpy.simulator.ravaflow24.Ravaflow24Mixture
:members: preprocess, run, extract_impact_area, extract_qoi_max, extract_qoi_max_loc
\ No newline at end of file
Run Simulator
-------------
=============
RunSimulator Class
^^^^^^^^^^^^^^^^^^
------------------
The :class:`.RunSimulator` class is imported by::
from psimpy.simulator.run_simulator import RunSimulator
Methods
*******
^^^^^^^
.. autoclass:: psimpy.simulator.run_simulator.RunSimulator
:members: serial_run, parallel_run
Attributes
**********
^^^^^^^^^^
.. autoattribute:: psimpy.simulator.run_simulator.RunSimulator.var_samples
.. autoattribute:: psimpy.simulator.run_simulator.RunSimulator.outputs
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment