Release v0.3.1

What's Changed

• Bug fix in reading dataframes without geometry
• Added function arguments to enable use of D-HYDRO executables

Full Changelog: 0.3.0...0.3.1

Release v0.3.0

What's Changed

Removed HydroMT-Delft3D FM plugin (#176)

New D-HyDAMO improvements (#181)

1D

• Significant speed up of processing profile points;
• Implemented function ‘snap_and_drop’ to be able to drop non-spatial objects that are related to spatial objects that are removed because they are too far from a hydroobject;
• When a parameterized profile is coupled to a hydroobject; two profiles are created at 5 and 95% of the branch length with the upper- and lower bottom height, respectively. Previously, one profile was created in the middle with the average bedlevel;
• Trapezium-shaped crosssections were erroneously not written to the model, this is now fixed;
• When for a universal weir no ‘laagstedoorstroomhoogte’ is provided, it is now taken from the lowest point of the provided profile (instead of writing a NaN-value);
• Previously, D-HyDAMO crashed when an empty layer was supplied in the Geopackage. Now a warning is issued and the remaining layers are read;
• Added warning messages when no openings or management_devices are related to a weir. Previously the weir was silently skipped in those cases;
• Expanded several warnings to provide more information about the objects they pertain to;
• Removed (to-be) deprecated pandas functions;
• Now using ‘pyogrio’, leading to a considerable speedup in reading GPKG-files.

Required changes to the workflow

• When a polygon-type layer (“afvoeraanvoergebied” or a “rioleringsgebied”) contains multi-polygons, the argument “check_geotype” to “read_gpkg_layer” should be set to “False”. Otherwise only singlepart polygons are allowed;
• To drop related objects to an object being snapped, change the snapping-commands to (for instance):

hydamo.snap_to_branch_and_drop(hydamo.pumpstations, hydamo.branches, snap_method="overal", maxdist=10, drop_related=True)

• It is now possible to also place calculation points around not only structures, but also around observation points. For RTC to function correctly, a structure needs to be separated from its associated observation points. To enable this, observation points need to be defined in the workflow before calculation points are defined and the observation points need to be added to the list of structures used to define calculation point locations:

objects = pd.concat([structures, hydamo.observationpoints.observation_points], axis=0)

“Objects” is then passed the function that defines the calculation points (“mesh1d_add_branches_from_gdf”). See the notebook for details.

2D

• There is now a choice between using the gridgeom-concept for meshgeneration (“GG”), which was also implemented in delft3dfmpy (the predecessor of Hydrolib-DHYDAMO) and meshkernel (3.0) (“MK”). This is the case because clipping waterbodies from the mesh using meshkernel sometimes led to strange mesh geometries;
• 1D2D link creation is now considerably faster.

Required changes to the workflow

• Choose a 2D mesh generation concept: GG or MK. When GG is used, the functions are different than for MK. See the notebook for the correct syntax.

RTC

• Added support for interval controllers;
• Added support for setpoint timeseries for both PID and interval controllers;
• Fixed a bug in writing the dimr-config file for controllers that control discharge instead of water level. Previously always ‘water level’ was written.

Required changes to the workflow

• When RTC-controllers are added individually in the workflow, previously a dictionary with controller-settings (“pid_settings”) was passed to the function “add_pid_controller”. Now the settings (ki, kp, kd and max_speed) are passed individually; pid_settings is no longer an argument to “add_pid_controller”. The same holds for the newly available “interval_settings”. However, these objects are still needed to create controllers from the HyDAMO database using the function ‘from_hydamo’. These settings are not included in the HyDAMO data and therefore still need to be provided. See the example notebook for details.

RR

• Changed definition of paved node routing in paved.3b to ‘2 2’;
• Catchments that are of type multi-polygon are no longer automatically exploded to singlepart, but now a node is created per multi-polygon;
• Added empty temperature file to prevent an error in D-Hydro
• Updated the way sewer pump capacity was handled. A raster was supposed to be provided with the capacity in m3/s. Now there are multiple options:
• Provide one as a column in ‘hydamo.sewer_area’ with units m3/s. The pump capacity is divided over the overflows according the associated fractions;
• Provide one as a raster in mm/h. The values from the raster are averaged over a sewer area and converted to m3/s;
• Provide a single number in mm/h that applied to all sewer areas and converted to m3/s.

Required changes to the workflow

• Pump capacity for paved nodes can now be provided in three ways:
  • Provide one as a column in ‘hydamo.sewer_area’ with units m3/s. The pump capacity is divided over the overflows according the the associated fractions.
  • Provide one as a raster in mm/h. The values from the raster are averaged over a sewer area and converted to m3/s.
  • Provide a single number in mm/h that is applied to all sewer areas and converted to m3/s.
    In the notebook a cell has been added to change the fm-time step to the smallest timestep the other modules if applicable (RR and/or RTC), otherwise water balance problems may occur:

Full Changelog: 0.2.0...0.3.0

Release v0.2.0

What's Changed

Feat

• D-HyDAMO: Set branch order to allow interpolation of crosssections
• D-HyDAMO: Allow creation of compound structures
• D-HyDAMO: Example notebook with extended demo of new functionalities and custom MDU settings and 2D functionalities

Fix

• D-HyDAMO: Crosssections that are assigned to a structure could (erroneously) also be assigned to a branch

Full Changelog: 0.1.2...0.2.0