diff --git a/docs/assets/c4_component_ribasim.mmd b/docs/assets/c4_component_ribasim.mmd new file mode 100644 index 000000000..5b751e62a --- /dev/null +++ b/docs/assets/c4_component_ribasim.mmd @@ -0,0 +1,39 @@ +flowchart TB +modeler([Modeler]):::user + +api["Ribasim Python\n[python]"]:::system +modeler-->|prepare model|api + +subgraph ribasimBoundary[Ribasim] + ribasim["Ribasim.jl\n[julia]"]:::system + libribasim["libribasim\n[julia + python + BMI]"]:::system + cli["Ribasim CLI\n[julia]"]:::system + cli-->ribasim + libribasim-->ribasim +end +modeler-->|start|cli +modeler-->|coupled simulation|libribasim + +subgraph qgisBoundary[QGIS] + QGIS[QGIS Application]:::system_ext + qgisPlugin["Ribasim QGIS plugin\n[python]"]:::system + QGIS-->qgisPlugin +end +modeler-->|prepare model|qgisBoundary + +model[("input model data\n[toml + geopackage + arrow]")]:::system +qgisPlugin-->|read/write|model +api-->|read/write|model +ribasim-->|simulate|model + +output[("simulation output\n[arrow]")]:::system +ribasim-->|write|output + +class qgisBoundary,ribasimBoundary boundary + +%% class definitions for C4 model +classDef default stroke-width:1px,stroke:white,color:white +classDef system fill:#1168bd +classDef user fill:#08427b +classDef system_ext fill:#999999 +classDef boundary fill:transparent,stroke-dasharray:5 5,stroke:black,color:black diff --git a/docs/assets/c4_system.mmd b/docs/assets/c4_system.mmd new file mode 100644 index 000000000..7a40986fa --- /dev/null +++ b/docs/assets/c4_system.mmd @@ -0,0 +1,32 @@ +flowchart TB +modeler([Modeler]):::user + +api["Ribasim Python\n[python]"]:::system +modeler-->|prepare model|api + +ribasim["Ribasim\n[julia]"]:::system +modeler-->|start|ribasim + +subgraph qgisBoundary[QGIS] + QGIS[QGIS Application]:::system_ext + qgisPlugin["Ribasim QGIS plugin\n[python]"]:::system + QGIS-->qgisPlugin +end +modeler-->|prepare model|qgisBoundary + +model[("input model data\n[toml + geopackage + arrow]")]:::system +qgisPlugin-->|read/write|model +api-->|read/write|model +ribasim-->|simulate|model + +output[("simulation results\n[arrow]")]:::system +ribasim-->|write|output + +class qgisBoundary boundary + +%% class definitions for C4 model +classDef default stroke-width:1px,stroke:white,color:white +classDef system fill:#1168bd +classDef user fill:#08427b +classDef system_ext fill:#999999 +classDef boundary fill:transparent,stroke-dasharray:5 5,stroke:black,color:black diff --git a/docs/core/index.qmd b/docs/core/index.qmd index 407dd2bf7..daeb53b2b 100644 --- a/docs/core/index.qmd +++ b/docs/core/index.qmd @@ -11,3 +11,8 @@ The core is implemented in the [Julia programming language](https://julialang.or can be found in the [Ribasim repository](https://github.com/Deltares/Ribasim) under the `core/` folder. For developers we also advise to read the [developer documentation](../contribute/core.qmd). + +```{mermaid} +%%| file: ../assets/c4_component_ribasim.mmd +%%| fig-cap: "Component overview of Ribasim" +``` diff --git a/docs/index.qmd b/docs/index.qmd index 8597df9a7..02a595d70 100644 --- a/docs/index.qmd +++ b/docs/index.qmd @@ -44,6 +44,11 @@ Currently only Windows builds for `ribasim_cli.zip` are available. See [Usage](core/usage.qmd) for more information. +```{mermaid} +%%| file: assets/c4_system.mmd +%%| fig-cap: "System overview of Ribasim" +``` + # Status The initial focus is on being able to