chore: Updated the list of supported functionalities

refs: #466
Deltares · Apr 14, 2023 · 2168ba5 · 2168ba5
1 parent cbb80af
commit 2168ba5
Show file tree

Hide file tree

Showing 6 changed files with 56 additions and 26 deletions.
diff --git a/docs/reference/obs.md b/docs/reference/obs.md
diff --git a/docs/reference/observationcrosssection.md b/docs/reference/observationcrosssection.md
@@ -0,0 +1,27 @@
+# Observation cross section files
+
+Observation cross section files come in two flavours:
+
+* the official `*_crs.ini` format [see below](#observation-cross-section-ini-files)
+* the legacy `*.pli` format  [see below](#legacy-observation-cross-section-pli-files)
+
+# Observation cross section .ini files
+The `obscrosssection` module provides the specific logic for accessing observation cross section .ini files.
+for a [D-Flow FM](glossary.md#d-flow-fm) model.
+
+Generic parsing and serializing functionality comes from the generic hydrolib.core.dflowfm.ini modules.
+
+An observation cross section .ini file is described by the classes below.
+
+## Model
+
+::: hydrolib.core.dflowfm.obscrosssection.models
+
+# Legacy observation cross section .pli files
+Legacy .pli files for observation points are supported via the generic `polyfile` module.
+
+A polyfile (hence also an observation cross section .pli file) is described by the classes below.
+
+## Model
+
+::: hydrolib.core.dflowfm.polyfile.models
diff --git a/docs/reference/observationpoint.md b/docs/reference/observationpoint.md
@@ -0,0 +1,27 @@
+# Observation point files
+Observation point files come in two flavours:
+
+* the official `*_obs.ini` format [see below](#observation-point-ini-files)
+* the legacy `*.xyn` format  [see below](#legacy-observation-point-xyn-files)
+
+# Observation point .ini files
+The `obs` module provides the specific logic for accessing observation point .ini files
+for a [D-Flow FM](glossary.md#d-flow-fm) model.
+
+Generic parsing and serializing functionality comes from the generic hydrolib.core.dflowfm.ini modules.
+
+An observation point .ini file is described by the classes below.
+
+## Model
+
+::: hydrolib.core.dflowfm.obs.models
+
+# Legacy observation point .xyn files
+The `xyn` module provides the specific logic for accessing legacy observation point files
+for a [D-Flow FM](glossary.md#d-flow-fm) model.
+
+An observation point .xyn file is described by the classes below.
+
+## Model
+
+::: hydrolib.core.dflowfm.xyn.models
diff --git a/docs/reference/xyn.md b/docs/reference/xyn.md
diff --git a/docs/topics/dhydro_support_hydrolib-core.xlsx b/docs/topics/dhydro_support_hydrolib-core.xlsx
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -114,7 +114,8 @@ nav:
           - reference/onedfield.md
           - reference/polyfile.md
           - reference/xyz.md
-          - reference/obs.md
+          - reference/observationpoint.md
+          - reference/observationcrosssection.md
       - RainfallRunoff:
           - reference/rr/rr.md
           - reference/rr/meteo.md