.. Hydroflow documentation file, created by
   Pierre-Yves Gousenbourger on Mon Jan 8, 2024.

.. _users:


#################
Watlab user guide
#################

This guide is an overview of the possibilities of Watlab. It guides the user through the main features. For more details, see :ref:`documentation`.


.. toctree::
   :caption: Get started
   :maxdepth: 1

   quick-install
   run-watlab
   create-mesh

.. toctree::
   :caption: The physics within Watlab
   :maxdepth: 1
   
   governing-eqs
   solvers
   modules

.. toctree::
   :caption: Examples
   
   ../tutorials/hydroflow/01-simple-dam-break/01-simple-dam-break.ipynb
   ../tutorials/hydroflow/02_advanced_dam_break/02-advanced-dam-break.ipynb
   ../tutorials/hydroflow/03_remeshing_example/03-remeshing-example.ipynb
   ../tutorials/hydroflow/04_lab_simulation/04-lab-simulation.ipynb
   ../tutorials/hydroflow/05_circular_dam_break/05-circular-dam-break.ipynb