diff --git a/docs/source/index.rst b/docs/source/index.rst index 85b2b8947dd065e91a8a70b3bad0a51781e6259f..c9303db3bd0a54474b6bb740ba24ff4d5b0a9bba 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,6 +1,5 @@ :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 diff --git a/docs/source/inference/active_learning.rst b/docs/source/inference/active_learning.rst index 2cf97077af84babb368b7c52beb6006b1aaeb235..d2de2749ec6ac327c63dd341cfb3b2f6327c5707 100644 --- a/docs/source/inference/active_learning.rst +++ b/docs/source/inference/active_learning.rst @@ -1,14 +1,14 @@ 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 diff --git a/docs/source/inference/bayes_inference.rst b/docs/source/inference/bayes_inference.rst index f945d0be6f8466a5557008408c2cee3d52aab747..9ccb48886a103e0db8e89042bc7559fe6827afdb 100644 --- a/docs/source/inference/bayes_inference.rst +++ b/docs/source/inference/bayes_inference.rst @@ -1,27 +1,27 @@ 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 diff --git a/docs/source/inference/index.rst b/docs/source/inference/index.rst index 5ddca83d4694715fbc3f62d16fbd7528a762a784..092e1cfef4aa5ece9727e17d39023e66675d6910 100644 --- a/docs/source/inference/index.rst +++ b/docs/source/inference/index.rst @@ -1,5 +1,6 @@ +********* Inference -========= +********* This module hosts functionality for inference methods. diff --git a/docs/source/sampler/index.rst b/docs/source/sampler/index.rst index 35914fd7aa2b61585d1a70cd1832dd469b1804f0..25e9f3ef51aeed597da03801176960287c2c7382 100644 --- a/docs/source/sampler/index.rst +++ b/docs/source/sampler/index.rst @@ -1,5 +1,6 @@ +******* Sampler -======= +******* This module hosts functionality for sampling methods. diff --git a/docs/source/sampler/latin.rst b/docs/source/sampler/latin.rst index d7dd64da13f3c6237db3ea59e89375cb3b7e5525..060f9d6b9d34a85b483419b1729be8a404e92ca3 100644 --- a/docs/source/sampler/latin.rst +++ b/docs/source/sampler/latin.rst @@ -1,14 +1,14 @@ 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 diff --git a/docs/source/sampler/metropolis_hastings.rst b/docs/source/sampler/metropolis_hastings.rst index 7b6df1cbb8ae2f9e81f9b5e9de3580855bd3cc6f..6b2c868a41b7904003f11ae3637829873b464e18 100644 --- a/docs/source/sampler/metropolis_hastings.rst +++ b/docs/source/sampler/metropolis_hastings.rst @@ -1,14 +1,14 @@ 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 diff --git a/docs/source/sampler/saltelli.rst b/docs/source/sampler/saltelli.rst index 1010be6bab20de6ff5e1619331dc4e43eb25162b..0b7b340dc9d09aa366b464c117eb5e489ed71b5f 100644 --- a/docs/source/sampler/saltelli.rst +++ b/docs/source/sampler/saltelli.rst @@ -1,14 +1,14 @@ 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 diff --git a/docs/source/sensitivity/index.rst b/docs/source/sensitivity/index.rst index a93a04d3a89ef6913d4e4c0d68b95f5d0d9a5f98..5e60a0abcd3aba93302e0055beb6a48b3a5500f5 100644 --- a/docs/source/sensitivity/index.rst +++ b/docs/source/sensitivity/index.rst @@ -1,5 +1,6 @@ +*********** Sensitivity -=========== +*********** This module hosts functionality for methods of sensitivity analysis. diff --git a/docs/source/sensitivity/sobol.rst b/docs/source/sensitivity/sobol.rst index 6eee63372f62ec0c4ba9a4b4b882ba4f33e15d01..7c59f927ebe5ea5e1b6f883d59231b6185bb88c4 100644 --- a/docs/source/sensitivity/sobol.rst +++ b/docs/source/sensitivity/sobol.rst @@ -1,14 +1,14 @@ 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 diff --git a/docs/source/simulator/index.rst b/docs/source/simulator/index.rst index 08f5572bc2f777983c224e0d87ed97ef02916a9e..3021216d4424a463f08a8d3bfd698648c3bfac24 100644 --- a/docs/source/simulator/index.rst +++ b/docs/source/simulator/index.rst @@ -1,5 +1,6 @@ +********* Simulator -========= +********* This module hosts functionality for running simulators, as well as some simulators used in the landslide community. diff --git a/docs/source/simulator/mass_point_model.rst b/docs/source/simulator/mass_point_model.rst index 33a283911ab769acb6440acdc505aa917933f3da..c21845a7367cb023c02c42e07b601ad977cd92d4 100644 --- a/docs/source/simulator/mass_point_model.rst +++ b/docs/source/simulator/mass_point_model.rst @@ -1,14 +1,14 @@ 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 diff --git a/docs/source/simulator/ravaflow24.rst b/docs/source/simulator/ravaflow24.rst index 5f52ec2f8dd364144d87771e9c4a4b329a19898b..35fd7860bdd343696be63547baa0cb2e4199352f 100644 --- a/docs/source/simulator/ravaflow24.rst +++ b/docs/source/simulator/ravaflow24.rst @@ -1,14 +1,14 @@ 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 diff --git a/docs/source/simulator/run_simulator.rst b/docs/source/simulator/run_simulator.rst index 2c3d62804256fb902aa2901ea348d48e924c42f1..95efe48da91e42341b627d043c57c463c8f838ea 100644 --- a/docs/source/simulator/run_simulator.rst +++ b/docs/source/simulator/run_simulator.rst @@ -1,19 +1,19 @@ 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