Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
P
psimpy
Manage
Activity
Members
Labels
Plan
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
GitLab community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
mbd
psimpy
Commits
c5950906
Commit
c5950906
authored
1 year ago
by
Nicholas Book
Browse files
Options
Downloads
Patches
Plain Diff
updated ravaflow-related docs
parent
256aad8f
No related branches found
No related tags found
No related merge requests found
Changes
3
Show whitespace changes
Inline
Side-by-side
Showing
3 changed files
docs/source/simulator/index.rst
+5
-5
5 additions, 5 deletions
docs/source/simulator/index.rst
docs/source/simulator/ravaflow3G.rst
+26
-0
26 additions, 0 deletions
docs/source/simulator/ravaflow3G.rst
src/psimpy/simulator/ravaflow3G.py
+2
-2
2 additions, 2 deletions
src/psimpy/simulator/ravaflow3G.py
with
33 additions
and
7 deletions
docs/source/simulator/index.rst
+
5
−
5
View file @
c5950906
...
@@ -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:`.Ravaflow
24
Mixture`: Voellmy-type shallow flow model for landslide run-out simulation.
* :class:`.Ravaflow
3G
Mixture`: 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 <ravaflow
24
>
Ravaflow Mixture Model <ravaflow
3G
>
.. note::
.. note::
:class:`.MassPointModel` and :class:`.Ravaflow
24
Mixture` are only relevant if
:class:`.MassPointModel` and :class:`.Ravaflow
3G
Mixture` 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:`.Ravaflow
24
Mixture` depends on
Python-based and can be used right away. :class:`.Ravaflow
3G
Mixture` 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
This diff is collapsed.
Click to expand it.
docs/source/simulator/ravaflow
24
.rst
→
docs/source/simulator/ravaflow
3G
.rst
+
26
−
0
View file @
c5950906
Ravaflow
24
Mixture Model
Ravaflow
3G
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.ravaflow
24
`, we have implemented class
In :py:mod:`PSimPy.simulator.ravaflow
3G
`, we have implemented class
:class:`.Ravaflow
24
Mixture`. It provides a
n
Python interface to directly run
:class:`.Ravaflow
3G
Mixture`. 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:`.Ravaflow
24
Mixture` class is imported by::
The :class:`.Ravaflow
3G
Mixture` class is imported by::
from psimpy.simulator.ravaflow
24
import Ravaflow
24
Mixture
from psimpy.simulator.ravaflow
3G
import Ravaflow
3G
Mixture
Methods
Methods
^^^^^^^
^^^^^^^
.. autoclass:: psimpy.simulator.ravaflow
24
.Ravaflow
24
Mixture
.. autoclass:: psimpy.simulator.ravaflow
3G
.Ravaflow
3G
Mixture
: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
This diff is collapsed.
Click to expand it.
src/psimpy/simulator/ravaflow3G.py
+
2
−
2
View file @
c5950906
...
@@ -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
"
)
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment