diff --git a/docs/source/simulator/index.rst b/docs/source/simulator/index.rst index 66c9249046a14e4806adb5b0a54202755a303285..97dd2d8bd81db5149d791fe55ba622c15a419cb6 100644 --- a/docs/source/simulator/index.rst +++ b/docs/source/simulator/index.rst @@ -19,7 +19,7 @@ implemented classes are: * :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:: :maxdepth: 1 @@ -28,11 +28,11 @@ implemented classes are: Run Simulator <run_simulator> Mass Point Model <mass_point_model> - Ravaflow Mixture Model <ravaflow24> + Ravaflow Mixture Model <ravaflow3G> .. 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 - Python-based and can be used right away. :class:`.Ravaflow24Mixture` depends on - `r.avaflow 2.4 <https://www.landslidemodels.org/r.avaflow/>`_, which needs to be + Python-based and can be used right away. :class:`.Ravaflow3GMixture` depends on + `r.avaflow 3G <https://www.landslidemodels.org/r.avaflow/>`_, which needs to be installed by the user. \ No newline at end of file diff --git a/docs/source/simulator/ravaflow24.rst b/docs/source/simulator/ravaflow24.rst deleted file mode 100644 index fc5aa6df8a09e68c130602fb12c3c7be95eae34a..0000000000000000000000000000000000000000 --- a/docs/source/simulator/ravaflow24.rst +++ /dev/null @@ -1,24 +0,0 @@ -Ravaflow24 Mixture Model -======================== - -`r.avaflow 2.4` is a GIS-supported open source software for mass flow modeling. -It is developed by :cite:t:`Mergili2017`. For more information see its official -user manual `here <https://www.landslidemodels.org/r.avaflow/>`_. - -In :py:mod:`PSimPy.simulator.ravaflow24`, we have implemented class -:class:`.Ravaflow24Mixture`. It provides an Python interface to directly run -the `Voellmy-tpye shallow flow model` of `r.avaflow 2.4` from within Python. -For detailed theory of `Voellmy-tpye shallow flow model`, one can refer to -:cite:t:`Christen2010` and :cite:t:`Fischer2012`. - -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/ravaflow3G.rst b/docs/source/simulator/ravaflow3G.rst new file mode 100644 index 0000000000000000000000000000000000000000..d160fcb1eaf469bc680088f64bb045161fa32a70 --- /dev/null +++ b/docs/source/simulator/ravaflow3G.rst @@ -0,0 +1,26 @@ +Ravaflow3G Mixture Model +======================== + +`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 +user manual `here <https://www.landslidemodels.org/r.avaflow/>`_. + +In :py:mod:`PSimPy.simulator.ravaflow3G`, we have implemented class +:class:`.Ravaflow3GMixture`. It provides a Python interface to directly run +the `Voellmy-tpye shallow flow model` of `r.avaflow 3G` from within Python. +For detailed theory of `Voellmy-tpye shallow flow model`, please refer to +:cite:t:`Christen2010` and :cite:t:`Fischer2012`. + +Please note that the :py:mod:`PSimPy.simulator.ravaflow24` module corresponding to `r.avaflow 2.4` has been deprecated. + +Ravaflow3GMixture Class +----------------------- + +The :class:`.Ravaflow3GMixture` class is imported by:: + + from psimpy.simulator.ravaflow3G import Ravaflow3GMixture + +Methods +^^^^^^^ +.. autoclass:: psimpy.simulator.ravaflow3G.Ravaflow3GMixture + :members: preprocess, run, extract_impact_area, extract_qoi_max, extract_qoi_max_loc \ No newline at end of file diff --git a/src/psimpy/simulator/ravaflow3G.py b/src/psimpy/simulator/ravaflow3G.py index 0c0910b8980dcd5dcb12851e43dccdd7a80cfbb0..6079fd2640b8d890457c3064431488ed4af42f74 100644 --- a/src/psimpy/simulator/ravaflow3G.py +++ b/src/psimpy/simulator/ravaflow3G.py @@ -191,7 +191,7 @@ class Ravaflow3GMixture: except for :math:`0` meaning no entrainment. EPSG : str, optional `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 metadata to create the GRASS Location. @@ -201,7 +201,7 @@ class Ravaflow3GMixture: Name of the `GRASS Location` (including path). sh_file : str 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")