Mesh

docs/api.rst

@@ -28,6 +28,22 @@ Setup components
    :toctree: _generated
 
    DFlowFMModel.setup_config
+   DFlowFMModel.setup_channels
+   DFlowFMModel.setup_rivers_from_dem
+   DFlowFMModel.setup_rivers
+   DFlowFMModel.setup_pipes
+   DFlowFMModel.setup_manholes
+   DFlowFMModel.setup_1dboundary
+   DFlowFMModel.setup_bridges
+   DFlowFMModel.setup_culverts
+   DFlowFMModel.setup_mesh2d
+   DFlowFMModel.setup_mesh2d_refine
+   DFlowFMModel.setup_link1d2d
+   DFlowFMModel.setup_maps_from_rasterdataset
+   DFlowFMModel.setup_maps_from_raster_reclass
+   DFlowFMModel.setup_2dboundary
+   DFlowFMModel.setup_rainfall_from_constant
+   DFlowFMModel.setup_rainfall_from_uniform_timeseries
 
 Attributes
 ----------
@@ -36,15 +52,25 @@ Attributes
    :toctree: _generated
 
    DFlowFMModel.region
+   DFlowFMModel.bounds
    DFlowFMModel.crs
    DFlowFMModel.res
    DFlowFMModel.root
    DFlowFMModel.config
-   DFlowFMModel.staticmaps
-   DFlowFMModel.staticgeoms
+   DFlowFMModel.maps
+   DFlowFMModel.geoms
    DFlowFMModel.forcing
    DFlowFMModel.states
    DFlowFMModel.results
+   DFlowFMModel.mesh
+   DFlowFMModel.dfmmodel
+   DFlowFMModel.dimr
+   DFlowFMModel.branches
+   DFlowFMModel.rivers
+   DFlowFMModel.channels
+   DFlowFMModel.pipes
+   DFlowFMModel.opensystem
+   DFlowFMModel.closedsystem
 
 
 High level methods
@@ -58,6 +84,8 @@ High level methods
    DFlowFMModel.build
    DFlowFMModel.update
    DFlowFMModel.set_root
+   DFlowFMModel._model_has_2d
+   DFlowFMModel._model_has_1d
 
 General methods
 ---------------
@@ -72,18 +100,17 @@ General methods
    DFlowFMModel.read_config
    DFlowFMModel.write_config
 
-   DFlowFMModel.set_staticmaps
-   DFlowFMModel.read_staticmaps
-   DFlowFMModel.write_staticmaps
-   DFlowFMModel.clip_staticmaps
-   DFlowFMModel.set_staticgeoms
-   DFlowFMModel.read_staticgeoms
-   DFlowFMModel.write_staticgeoms
+   DFlowFMModel.set_maps
+   DFlowFMModel.read_maps
+   DFlowFMModel.write_maps
+
+   DFlowFMModel.set_geoms
+   DFlowFMModel.read_geoms
+   DFlowFMModel.write_geoms
 
    DFlowFMModel.set_forcing
    DFlowFMModel.read_forcing
    DFlowFMModel.write_forcing
-   DFlowFMModel.clip_forcing
 
    DFlowFMModel.set_states
    DFlowFMModel.read_states
@@ -92,11 +119,22 @@ General methods
    DFlowFMModel.set_results
    DFlowFMModel.read_results
 
+   DFlowFMModel.set_mesh
+   DFlowFMModel.set_link1d2d
+   DFlowFMModel.read_mesh
+   DFlowFMModel.write_mesh
+
+   DFlowFMModel.read_dimr
+   DFlowFMModel.write_dimr
+
+
+   DFlowFMModel.get_model_time
+
 
 .. _workflows:
 
-Wflow workflows
-===============
+DFlowFMModel workflows
+======================
 
 .. autosummary::
    :toctree: _generated
@@ -107,7 +145,7 @@ Wflow workflows
 .. _methods:
 
 DFlowFM low-level methods
-=======================
+=========================
 
 Input/Output methods
 ---------------------
@@ -116,3 +154,16 @@ Input/Output methods
    :toctree: _generated
 
    utils.read_branches_gui
+
+Mesh conversion methods
+-----------------------
+
+.. autosummary::
+   :toctree: _generated
+
+   mesh_utils.hydrolib_network_from_mesh
+   mesh_utils.mesh1d_network1d_from_hydrolib_network
+   mesh_utils.links1d2d_from_hydrolib_network
+   mesh_utils.mesh_from_hydrolib_network
+   mesh_utils.mesh1d_nodes_geodataframe
+   mesh_utils.network1d_nodes_geodataframe

envs/hydromt-delft3dfm.yml

@@ -8,7 +8,6 @@ channels:
 dependencies:
   - black # linting
   - flit>=3.4
-  - hydromt>=0.7.0
   - jupyter # to run examples
   - matplotlib # to run examples
   - nbsphinx # docs notebook examples
@@ -32,6 +31,8 @@ dependencies:
   - xarray
   - xugrid
   - networkx
+  - llvmlite>=0.39.1 # hydrolib-core
   - pip:
-      - hydrolib-core
-      - meshkernel
+      - git+https://github.com/Deltares/hydromt.git
+      - hydrolib-core==0.5.2
+      - meshkernel==2.0.2 # temp pin because of hydrolib-core

examples/dflowfm_build.yml

@@ -0,0 +1,63 @@
+global:
+  crs: 3857
+  network_snap_offset: 25
+  openwater_computation_node_distance: 40
+
+setup_rivers_from_dem:
+  region: 
+    bbox: [12.4331, 46.4661, 12.5212, 46.5369]
+  hydrography_fn: merit_hydro
+  river_geom_fn: rivers_lin2019_v1
+  rivdph_method: gvf
+  rivwth_method: geom
+  river_upa: 25.0
+  friction_type: "Manning"
+  friction_value: 0.023
+  rivbankq: 25
+
+setup_pipes:
+  region: 
+    bbox: [12.4331, 46.4661, 12.5212, 46.5369]
+  pipes_fn: grip_roads
+  pipe_filter: pipe
+  spacing: 50
+  friction_type: WhiteColeBrook
+  friction_value: 0.003
+  crosssections_shape: circle
+  crosssections_value: 0.5
+  dem_fn: merit_hydro # [copdem30, merit]
+  pipes_depth: 2.0
+  snap_offset: 0.5
+  pipes_invlev: 3. 
+
+setup_manholes:
+  dem_fn: merit_hydro
+
+setup_1dboundary:
+  boundary_value: -2.0
+  branch_type: river
+  boundary_type: waterlevel
+  boundary_unit: m
+  boundary_locs: both
+
+setup_mesh2d:
+  region: 
+    bbox: [12.4331, 46.4661, 12.5212, 46.5369]
+  res: 500
+
+setup_maps_from_rasterdataset:
+  raster_fn: merit_hydro
+  variables: ["elevtn"]
+  fill_method: nearest
+  interpolation_method: nearestNb
+  split_dataset: True
+
+setup_maps_from_raster_reclass:
+  raster_fn: vito
+  reclass_table_fn: vito_mapping
+  reclass_variables: ['roughness_manning', 'infiltcap']
+  interpolation_method: triangulation
+  split_dataset: True
+
+setup_link1d2d:
+  link_direction: 1d_to_2d