Pydra Core

Pydra Core is a Python package containing (part of) the functionalities from Hydra-NL. Pydra was started as an experimental Python version of Hydra-NL, developed by HKV together with Rijkswaterstaat WVL. Pydra is maintained by HKV. For questions about how to use this package, contact n.vandervegt@hkv.nl.

Currently the following Hydra-NL functionalities are included:

• Exceedance Frequency Lines (Based on marginal statistics)
• HBN (Probabilistically Determined Required Crest Height)
• Profiles (Run-up, Average overtopping discharge, HBN)

For the following water systems:

• Non-Tidal Rivers (Bovenrivieren 01 Rijn, 02 Maas, 18 Maasvallei)
• Tidal Rivers (Benedenrivieren 03 Rijn, 04 Maas)
• Coast (09/10 Waddenzee Oost en West; 11/12/13 Hollandse Kust Noord, Midden en Zuid; 15 Westerschelde)
• Eastern Scheldt 'WBI2023' databases (14 Oosterschelde)
• Lakes (07 IJsselmeer; 08 Markermeer; 19 Grevelingen; 20 Veluwe randmeren)
• Vecht-IJssel Delta (05 IJssel Delta; 06 Vecht Delta)

Pydra Core is published under de GNU GPL-3 license. Certain submodules have their own licensing.

Getting started

Using pip to install the package separately

run pip install pydra-core

import pydra_core

profile = pydra_core.Profile("Borselle")
profile.set_dike_crest_level(10.75)
profile.set_dike_orientation(225)
profile.set_dike_geometry([-30, 30], [-10, 10])
profile.draw_profile()

Refer to the documentation for more examples.

Developing with pixi

To manage the environment we use Pixi.

Windows

iwr -useb https://pixi.sh/install.ps1 | iex

Linux/Mac

curl -fsSL https://pixi.sh/install.sh | bash

Installing

With the Pixi command in powershell install the python environment:

 cd ..../pydra_core
 pixi install

The pixi.lock file loads the correct packages and downloads to the .pixi file, you can use this environment in developing and resting.

Run pixi run quarto-render to create documentation locally, this will be in the docs\docs file.

Certain submodules depend on external libraries

The files CombOverloopOverslag64.dll and DynamicLib-DaF.dll are obtained from Hydra-NL v2.8.2 which is freely available through the dutch government and have been published with permission.

The dllDikesOvertopping.dll, feedbackDLL.dll, and libiomp5md.dll are part of DiKErnel which is made by Deltares and published under the GNU AFFERO GPL v3 license. These dll files are only included to make use of this package easier.