Skip to content

Commit

Permalink
documentatie (#161)
Browse files Browse the repository at this point in the history
@visr for now I use md-files as I cannot preview qmd-files in VSCode.
Please advice how to structure png-files (resources) and
documentation-files.

---------

Co-authored-by: Martijn Visser <[email protected]>
  • Loading branch information
DanielTollenaar and visr authored Oct 1, 2024
1 parent 71697aa commit 15022e4
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 15 deletions.
8 changes: 8 additions & 0 deletions docs/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,19 @@ website:
left:
- reference/index.qmd
- cloudstorage.qmd
- text: "Workflows"
file: workflow/main-watersystem.qmd
right:
- icon: github
href: https://github.com/Deltares/Ribasim-NL
aria-label: GitHub

sidebar:
- title: "Workflows"
contents:
- workflow/main-watersystem.qmd
- workflow/level-controlled.qmd

format:
html:
theme: cosmo
Expand Down
22 changes: 22 additions & 0 deletions docs/workflow/level-controlled.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: "Level controlled"
---

Workflow for deriving level controlled (peilbeheerst) regional models.
All code can be found under [`src/peilbeheerst_model`](https://github.com/Deltares/Ribasim-NL/tree/main/src/peilbeheerst_model).
The paths below are relative to this path.

1. Run the preprocessing notebooks. One notebook per water board, path: `peilbeheerst_model/preprocess_data/`
2. Run the postprocessing notebook. One notebook per water board, path: `peilbeheerst_model/postprocess_data/`
3. Run the crossings notebook. One notebook, path: `01_test_parse_crossings.ipynb`
4. Run shortest paths notebooks. One notebook per water board, path: `Shortest_path/`
5. Run crossings to Ribasim notebook. One notebook, all water boards are below each other, path: `02_crossings_to_ribasim_notebook.ipynb`
6. Run parametrize notebooks. One notebook per water board, for now only Amstel, Gooi en Vecht (AGV), path: `Parametrize/AmstelGooienVecht_parametrize.ipynb`

We originally had more parametrize notebooks, but because so much has changed I have now saved these in our backup.
We will only use these to see if there were any additional manual adjustments.
For the rest, it follows the same workflow as `AmstelGooienVecht_parametrize.ipynb`.

Finally: step 1 started with a clear notebook per water board.
During the process of 1.5 years, these notebooks have become increasingly larger and more confusing, whereby not every line is needed anymore.
For now, there is no priority to clean this up, partly because this is a major risk that the data will (unintentionally) change, which will change the networks and the feedback forms can no longer be used.
17 changes: 17 additions & 0 deletions docs/workflow/main-watersystem.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: "Main watersystem"
---

All files are in [`notebooks/rijkswaterstaat`](https://github.com/Deltares/Ribasim-NL/tree/main/notebooks/rijkswaterstaat) are numbered in order of execution.

# 1_bathymetrie.py
In this script we merge data from Baseline (version j23_6-v1, non-public) with grids from [bathymetrie-Nederland](https://maps.rijkswaterstaat.nl/geoweb55/index.html?viewer=Bathymetrie_Nederland) to one 5x5m GeoTiff.

We combine both sources as the Midden Limburgse en Noord Brabantse (MLNB) kanalen are not in Baseline and the IJsselmeer is not completely covered in bathymetrie-Nederland.
For the mask we use Top10NL waterdelen and manually filled a boolean column `baseline`.

::: {layout-ncol=2}
![Bathymetry mask](https://s3.deltares.nl/ribasim/doc-image/ribasim-nl/bathymetrie_mask.png)

![Bathymetry](https://s3.deltares.nl/ribasim/doc-image/ribasim-nl/bathymetrie_result.png)
:::
15 changes: 0 additions & 15 deletions src/peilbeheerst_model/Workflow_peilbeheerst_NL_LHM.txt

This file was deleted.

0 comments on commit 15022e4

Please sign in to comment.