Doc mkdoc

[AliceHarang]

New documentation!!!!

From Documentation2 branch when it began:

Create a documentation for the code

We have chosen to use doxygen associated to Mkdocs to create the documentation. The Doxygen part is directly created by a Mkdocs pluggin and added to the pages. the documentation is then pushed online automatically on: newDoc

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

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

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

Code documentation:

• Complete some documentation of the code (using AI tool in github)
• Review the param.h file (check all paramters are well defined and bring in doc)
• Test NIWA supercomputer scripts and create release

TODO:

• Add Westport input files
• Complete Westport with a timed version and new boundaries

[AliceHarang]

@CyprienBosserelle , this is the new documentation!
The style can be modified but the structure is now easy to modify and quite handy.
Not finished yet so feel free to have a look and add/modify stuff at the airport if you have time!

[CyprienBosserelle]

Looks Great. I'll try to modify a few documents and see how it goes

[AliceHarang]

To add to references:

• Kurganov, A., & Levy, D. (2002). Central-upwind schemes for the Saint-Venant system. Mathematical Modelling and Numerical Analysis, 36(3), 397-425.
• Kirstetter, G., Delestre, O., Lagree, P.-Y., Popinet, S., and Josserand, C.: B-flood 1.0: an open-source Saint-Venant model for flash flood simulation using adaptive refinement, Geosci. Model Dev. Discuss. [preprint], https://doi.org/10.5194/gmd-2021-15, in review, 2021.
• Buttinger-Kreuzhuber, A., Horvath, Z., Noelle, S., Bloschl, G., and Waser, J.: A fast second-order shallow water scheme on two-dimensional structured grids over abrupt topography, Advances in water resources, 127, 89-108, 2019.
• kurganov and Petrova 2007
• Smart friction paper
• Xia & Lang (2018): Xia and Lang (2018), https://doi.org/10.1016/j.advwatres.2018.05.004
• Iwagaki1955
• S. Popinet. Quadtree-adaptive tsunami modelling. Ocean Dynamics, doi: 61(9) : 1261 - 1285, 2011
• [Aureli 2020]
• [CEA2008]