Skip to content
Snippets Groups Projects
Commit c5950906 authored by Nicholas Book's avatar Nicholas Book
Browse files

updated ravaflow-related docs

parent 256aad8f
No related branches found
No related tags found
No related merge requests found
...@@ -19,7 +19,7 @@ implemented classes are: ...@@ -19,7 +19,7 @@ implemented classes are:
* :class:`.MassPointModel`: Mass point model for landslide run-out simulation. * :class:`.MassPointModel`: Mass point model for landslide run-out simulation.
* :class:`.Ravaflow24Mixture`: Voellmy-type shallow flow model for landslide run-out simulation. * :class:`.Ravaflow3GMixture`: Voellmy-type shallow flow model for landslide run-out simulation.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
...@@ -28,11 +28,11 @@ implemented classes are: ...@@ -28,11 +28,11 @@ implemented classes are:
Run Simulator <run_simulator> Run Simulator <run_simulator>
Mass Point Model <mass_point_model> Mass Point Model <mass_point_model>
Ravaflow Mixture Model <ravaflow24> Ravaflow Mixture Model <ravaflow3G>
.. note:: .. note::
:class:`.MassPointModel` and :class:`.Ravaflow24Mixture` are only relevant if :class:`.MassPointModel` and :class:`.Ravaflow3GMixture` are only relevant if
the user wants to perform run-out simulation. :class:`.MassPointModel` is purely the user wants to perform run-out simulation. :class:`.MassPointModel` is purely
Python-based and can be used right away. :class:`.Ravaflow24Mixture` depends on Python-based and can be used right away. :class:`.Ravaflow3GMixture` depends on
`r.avaflow 2.4 <https://www.landslidemodels.org/r.avaflow/>`_, which needs to be `r.avaflow 3G <https://www.landslidemodels.org/r.avaflow/>`_, which needs to be
installed by the user. installed by the user.
\ No newline at end of file
Ravaflow24 Mixture Model Ravaflow3G Mixture Model
======================== ========================
`r.avaflow 2.4` is a GIS-supported open source software for mass flow modeling. `r.avaflow 3G` is a GIS-supported open source software for mass flow modeling.
It is developed by :cite:t:`Mergili2017`. For more information see its official It is developed by :cite:t:`Mergili2017`. For more information see its official
user manual `here <https://www.landslidemodels.org/r.avaflow/>`_. user manual `here <https://www.landslidemodels.org/r.avaflow/>`_.
In :py:mod:`PSimPy.simulator.ravaflow24`, we have implemented class In :py:mod:`PSimPy.simulator.ravaflow3G`, we have implemented class
:class:`.Ravaflow24Mixture`. It provides an Python interface to directly run :class:`.Ravaflow3GMixture`. It provides a Python interface to directly run
the `Voellmy-tpye shallow flow model` of `r.avaflow 2.4` from within Python. the `Voellmy-tpye shallow flow model` of `r.avaflow 3G` from within Python.
For detailed theory of `Voellmy-tpye shallow flow model`, one can refer to For detailed theory of `Voellmy-tpye shallow flow model`, please refer to
:cite:t:`Christen2010` and :cite:t:`Fischer2012`. :cite:t:`Christen2010` and :cite:t:`Fischer2012`.
Ravaflow24Mixture Class Please note that the :py:mod:`PSimPy.simulator.ravaflow24` module corresponding to `r.avaflow 2.4` has been deprecated.
Ravaflow3GMixture Class
----------------------- -----------------------
The :class:`.Ravaflow24Mixture` class is imported by:: The :class:`.Ravaflow3GMixture` class is imported by::
from psimpy.simulator.ravaflow24 import Ravaflow24Mixture from psimpy.simulator.ravaflow3G import Ravaflow3GMixture
Methods Methods
^^^^^^^ ^^^^^^^
.. autoclass:: psimpy.simulator.ravaflow24.Ravaflow24Mixture .. autoclass:: psimpy.simulator.ravaflow3G.Ravaflow3GMixture
:members: preprocess, run, extract_impact_area, extract_qoi_max, extract_qoi_max_loc :members: preprocess, run, extract_impact_area, extract_qoi_max, extract_qoi_max_loc
\ No newline at end of file
...@@ -191,7 +191,7 @@ class Ravaflow3GMixture: ...@@ -191,7 +191,7 @@ class Ravaflow3GMixture:
except for :math:`0` meaning no entrainment. except for :math:`0` meaning no entrainment.
EPSG : str, optional EPSG : str, optional
`EPSG` (European Petroleum Survey Group) code to create `EPSG` (European Petroleum Survey Group) code to create
GRASS Location <https://grass.osgeo.org/grass82/manuals/grass_database.html>. `GRASS Location <https://grass.osgeo.org/grass82/manuals/grass_database.html>`_.
If `None`, ``elevation`` must be a georeferenced file which has If `None`, ``elevation`` must be a georeferenced file which has
metadata to create the GRASS Location. metadata to create the GRASS Location.
...@@ -201,7 +201,7 @@ class Ravaflow3GMixture: ...@@ -201,7 +201,7 @@ class Ravaflow3GMixture:
Name of the `GRASS Location` (including path). Name of the `GRASS Location` (including path).
sh_file : str sh_file : str
Name of the shell file (including path), which will be called by Name of the shell file (including path), which will be called by
`GRASS <https://grass.osgeo.org/>` to run the simulation. `GRASS <https://grass.osgeo.org/>`_ to run the simulation.
""" """
sh_file = os.path.join(self.dir_sim, f"{prefix}_shell.sh") sh_file = os.path.join(self.dir_sim, f"{prefix}_shell.sh")
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment