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

docs: create documentation for simulator module

parent f025b647
Branches
No related tags found
No related merge requests found
Simulator
=========
This module hosts functionality for running simulators, as well as some
simulators used in the landslide community.
Currently implemented classes are:
* :class:`.RunSimulator`:
* :class:`.MassPointModel`:
* :class:`.Ravaflow24Mixture`:
.. toctree::
:maxdepth: 1
:hidden:
:caption: Simulator
Run Simulator <run_simulator>
Mass Point Model <mass_point_model>
Ravaflow Mixture Model <ravaflow24>
\ No newline at end of file
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
\ 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