From bd4d18cdc6781f48d9c6287904c7856ed2ee7a4c Mon Sep 17 00:00:00 2001
From: Hu Zhao <zhao@mbd.rwth-aachen.de>
Date: Mon, 12 Dec 2022 13:49:12 +0100
Subject: [PATCH] docs: add documention for ravaflow24 mixture model

---
 docs/source/simulator/ravaflow24.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/docs/source/simulator/ravaflow24.rst b/docs/source/simulator/ravaflow24.rst
index 35fd786..fc5aa6d 100644
--- a/docs/source/simulator/ravaflow24.rst
+++ b/docs/source/simulator/ravaflow24.rst
@@ -1,6 +1,16 @@
 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
 -----------------------
 
-- 
GitLab