CyprienBosserelle / BG_Flood

Numerical model for simulating shallow water hydrodynamics on the GPU using an Adaptive Mesh Refinment type grid. The model was designed with the goal of simulating inundation (River, Storm surge or tsunami). The model uses a Block Uniform Quadtree approach that runs on the GPU but the adaptive/multi-resolution/AMR is being implemented and not yet operational. The core SWE engine and adaptivity has been inspired and taken from St Venant solver from Basilisk and the CUDA GPU memory model has been inspired by the work from Vacondio _et al._2017)

GNU General Public License v3.0

34 stars 15 forks source link

Create a documentation for the code

We have chosen to used doxygen directly to create the documentation. An other solution would be to use doxygen associated to phynx, using some "intermediate" tools.

[x] Include the images
[ ] Fix the latex formula
[ ] Add a biblio section
[x] Add a tutorial / example section
[ ] Add a proper description of the code in first-page
[x] Adjust the readme to link toward the doc
[ ] Add version control on the doxygen doc or/and adjust old doc
[x] Update badge (codacy and remove the build from Travis?)

Create some tutorial / example (basic/jupyter - python/Julia):

[ ] CEA2008
[ ] Aureli2020 (either CEA or Aureli)
[x] How to setup river flood model
[ ] How to setup tsunami model
[ ] Understand and visualise BG_Flood outputs
[x] Infiltration on Orowaiti

CyprienBosserelle / BG_Flood

Documentation #80

Create a documentation for the code