pydra-core 0.0.1__tar.gz → 0.0.3__tar.gz

{pydra_core-0.0.1 → pydra_core-0.0.3}/PKG-INFO

@@ -1,10 +1,16 @@
 Metadata-Version: 2.4
 Name: pydra_core
-Version: 0.0.1
+Version: 0.0.3
 Summary: Python package for calculating hydraulic loads
-Author: Paulina Kindermann, Jochem Caspers, David Haasnoot, Guy Dupuits, Jerom Aerts, Rolf Waterman, Bart Thonus, Marit Zethof
-Author-email: Niels van der Vegt <n.vandervegt@hkv.nl>
-License-Expression: GPL-3.0
+Project-URL: Documentation, https://hkv-products-services.github.io/pydra_core/
+Project-URL: Source, https://github.com/HKV-products-services/pydra_core
+Author-email: Niels van der Vegt <n.vandervegt@hkv.nl>, David Haasnoot <d.haasnoot@hkv.nl>
+License: GNU-GPL V3
+Requires-Dist: fiona
+Requires-Dist: matplotlib>=3.9.3
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: scipy
 Description-Content-Type: text/markdown
 
 # Pydra Core
@@ -13,9 +19,23 @@ This is a stable version of the Pydra, containing the core functionality of the
 Pydra was started as an experimental Python version of Hydra-NL
 Pydra is developed by HKV together with Rijkswaterstaat and Deltares and is published under de GNU GPL-3 license.
 
+## getting started
+
+To download the package run `pip install pydra-core`
+
+```py
+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()
+```
+
 ## Certain submodules have their own licensing
 
-> The files `CombOverloopOverslag64.dll` and `DynamicLib-DaF.dll` are obtained from [Hydra-NL v2.8.2](https://iplo.nl/thema/water/applicaties-modellen/waterveiligheidsmodellen/hydra-nl/) which is freely available through the dutch government.
+> The files `CombOverloopOverslag64.dll` and `DynamicLib-DaF.dll` are obtained from [Hydra-NL v2.8.2](https://iplo.nl/thema/water/applicaties-modellen/waterveiligheidsmodellen/hydra-nl/) which is freely available through the dutch government and have been published with permission.
 >
 > The `dllDikesOvertopping.dll` and `feedbackDLL.dll` are part of [DiKErnel](https://github.com/Deltares/DiKErnel) which is made by [Deltares](https://www.deltares.nl/en) and published under the
 > [GNU AFFERO GPL v3](https://github.com/Deltares/DiKErnel/blob/master/Licenses/Deltares/DikesOvertopping.LICENSE) license.

{pydra_core-0.0.1 → pydra_core-0.0.3}/README.md

@@ -1,13 +1,27 @@
-# Pydra Core
-
-This is a stable version of the Pydra, containing the core functionality of the Pydra package.
-Pydra was started as an experimental Python version of Hydra-NL
-Pydra is developed by HKV together with Rijkswaterstaat and Deltares and is published under de GNU GPL-3 license.
-
-## Certain submodules have their own licensing
-
-> The files `CombOverloopOverslag64.dll` and `DynamicLib-DaF.dll` are obtained from [Hydra-NL v2.8.2](https://iplo.nl/thema/water/applicaties-modellen/waterveiligheidsmodellen/hydra-nl/) which is freely available through the dutch government.
->
-> The `dllDikesOvertopping.dll` and `feedbackDLL.dll` are part of [DiKErnel](https://github.com/Deltares/DiKErnel) which is made by [Deltares](https://www.deltares.nl/en) and published under the
-> [GNU AFFERO GPL v3](https://github.com/Deltares/DiKErnel/blob/master/Licenses/Deltares/DikesOvertopping.LICENSE) license.
-> These dll files are only included to make use of this package easier.
+# Pydra Core
+
+This is a stable version of the Pydra, containing the core functionality of the Pydra package.
+Pydra was started as an experimental Python version of Hydra-NL
+Pydra is developed by HKV together with Rijkswaterstaat and Deltares and is published under de GNU GPL-3 license.
+
+## getting started
+
+To download the package run `pip install pydra-core`
+
+```py
+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()
+```
+
+## Certain submodules have their own licensing
+
+> The files `CombOverloopOverslag64.dll` and `DynamicLib-DaF.dll` are obtained from [Hydra-NL v2.8.2](https://iplo.nl/thema/water/applicaties-modellen/waterveiligheidsmodellen/hydra-nl/) which is freely available through the dutch government and have been published with permission.
+>
+> The `dllDikesOvertopping.dll` and `feedbackDLL.dll` are part of [DiKErnel](https://github.com/Deltares/DiKErnel) which is made by [Deltares](https://www.deltares.nl/en) and published under the
+> [GNU AFFERO GPL v3](https://github.com/Deltares/DiKErnel/blob/master/Licenses/Deltares/DikesOvertopping.LICENSE) license.
+> These dll files are only included to make use of this package easier.

{pydra_core-0.0.1 → pydra_core-0.0.3}/pydra_core/__init__.py

@@ -1,32 +1,32 @@
-__version__ = "0.0.1"
-#############################################################
-# Pydra (v2)
-# Contact: n.vandervegt@hkv.nl
-#############################################################
-
-# Core
-from .core.exceedance_frequency_line import ExceedanceFrequencyLine
-from .core.exceedance_frequency_line_experimental import (
-    ExceedanceFrequencyLineExperimental,
-)
-from .core.hbn import HBN
-
-# Enums
-from .common.enum import Breakwater
-from .common.enum import WaterSystem
-
-# Other
-from .hrdatabase.hrdatabase import HRDatabase
-from .location.location import Location
-from .location.profile.profile import Profile
-
-__all__ = [
-    "ExceedanceFrequencyLine",
-    "ExceedanceFrequencyLineExperimental",
-    "HBN",
-    "Breakwater",
-    "WaterSystem",
-    "HRDatabase",
-    "Location",
-    "Profile",
-]
+__version__ = "0.0.3"
+#############################################################
+# Pydra (v2)
+# Contact: n.vandervegt@hkv.nl
+#############################################################
+
+# Core
+from .core.exceedance_frequency_line import ExceedanceFrequencyLine
+from .core.exceedance_frequency_line_experimental import (
+    ExceedanceFrequencyLineExperimental,
+)
+from .core.hbn import HBN
+
+# Enums
+from .common.enum import Breakwater
+from .common.enum import WaterSystem
+
+# Other
+from .hrdatabase.hrdatabase import HRDatabase
+from .location.location import Location
+from .location.profile.profile import Profile
+
+__all__ = [
+    "ExceedanceFrequencyLine",
+    "ExceedanceFrequencyLineExperimental",
+    "HBN",
+    "Breakwater",
+    "WaterSystem",
+    "HRDatabase",
+    "Location",
+    "Profile",
+]

{pydra_core-0.0.1 → pydra_core-0.0.3}/pydra_core/common/common.py

@@ -1,98 +1,98 @@
-from .enum import WaterSystem
-
-
-class CommonFunctions:
-    """
-    A class with common functions.
-    """
-
-    @staticmethod
-    def is_coast(watersystem: WaterSystem) -> bool:
-        """
-        Returns True if a watersystem belongs to the coast loading model.
-
-        Parameters
-        ----------
-        watersystem : WaterSystem
-            The watersystem
-
-        Returns
-        -------
-        bool
-            True if the watersystem is Coast
-        """
-        if watersystem in [
-            WaterSystem.COAST_SOUTH,
-            WaterSystem.COAST_CENTRAL,
-            WaterSystem.COAST_NORTH,
-            WaterSystem.COAST_DUNES,
-            WaterSystem.WADDEN_SEA_WEST,
-            WaterSystem.WADDEN_SEA_EAST,
-            WaterSystem.WESTERN_SCHELDT,
-        ]:
-            return True
-        return False
-
-    @staticmethod
-    def is_lower_rivier(watersystem: WaterSystem) -> bool:
-        """
-        Returns True if a watersystem belongs to the lower river loading model.
-
-        Parameters
-        ----------
-        watersystem : WaterSystem
-            The watersystem
-
-        Returns
-        -------
-        bool
-            True if the watersystem is a lower river
-        """
-        if watersystem in [
-            WaterSystem.MEUSE_TIDAL,
-            WaterSystem.RHINE_TIDAL,
-            WaterSystem.EUROPOORT,
-        ]:
-            return True
-        return False
-
-    @staticmethod
-    def position_from_line(where, pt, refpts):
-        """
-        Check where a point is located relative to a line
-        """
-
-        def left(pt, refpts):
-            A, B = refpts
-            # Determine if the point is located left or right of the line
-            sign = ((B[0] - A[0]) * (pt[1] - A[1])) - ((B[1] - A[1]) * (pt[0] - A[0]))
-            if sign > 0:
-                left = True
-            else:
-                left = False
-            return left
-
-        if where == "north" or where == "south":
-            # Sorteer punten links naar recht, en kijk het links ligt
-            if refpts[0][0] > refpts[1][0]:
-                leftpoint, rightpoint = refpts[1], refpts[0]
-            else:
-                leftpoint, rightpoint = refpts[0], refpts[1]
-
-            # Bekijk of het punt links of recht van de lijn links naar rechts ligt
-            if where == "north":
-                return left(pt, [leftpoint, rightpoint])
-            else:
-                return left(pt, [rightpoint, leftpoint])
-
-        if where == "west" or where == "east":
-            # Sorteer punten onder naar boven, en kijk het links ligt
-            if refpts[0][1] > refpts[1][1]:
-                downpoint, toppoint = refpts[1], refpts[0]
-            else:
-                downpoint, toppoint = refpts[0], refpts[1]
-
-            if where == "west":
-                return left(pt, [downpoint, toppoint])
-            else:
-                return left(pt, [toppoint, downpoint])
+from .enum import WaterSystem
+
+
+class CommonFunctions:
+    """
+    A class with common functions.
+    """
+
+    @staticmethod
+    def is_coast(watersystem: WaterSystem) -> bool:
+        """
+        Returns True if a watersystem belongs to the coast loading model.
+
+        Parameters
+        ----------
+        watersystem : WaterSystem
+            The watersystem
+
+        Returns
+        -------
+        bool
+            True if the watersystem is Coast
+        """
+        if watersystem in [
+            WaterSystem.COAST_SOUTH,
+            WaterSystem.COAST_CENTRAL,
+            WaterSystem.COAST_NORTH,
+            WaterSystem.COAST_DUNES,
+            WaterSystem.WADDEN_SEA_WEST,
+            WaterSystem.WADDEN_SEA_EAST,
+            WaterSystem.WESTERN_SCHELDT,
+        ]:
+            return True
+        return False
+
+    @staticmethod
+    def is_lower_rivier(watersystem: WaterSystem) -> bool:
+        """
+        Returns True if a watersystem belongs to the lower river loading model.
+
+        Parameters
+        ----------
+        watersystem : WaterSystem
+            The watersystem
+
+        Returns
+        -------
+        bool
+            True if the watersystem is a lower river
+        """
+        if watersystem in [
+            WaterSystem.MEUSE_TIDAL,
+            WaterSystem.RHINE_TIDAL,
+            WaterSystem.EUROPOORT,
+        ]:
+            return True
+        return False
+
+    @staticmethod
+    def position_from_line(where, pt, refpts):
+        """
+        Check where a point is located relative to a line
+        """
+
+        def left(pt, refpts):
+            A, B = refpts
+            # Determine if the point is located left or right of the line
+            sign = ((B[0] - A[0]) * (pt[1] - A[1])) - ((B[1] - A[1]) * (pt[0] - A[0]))
+            if sign > 0:
+                left = True
+            else:
+                left = False
+            return left
+
+        if where == "north" or where == "south":
+            # Sorteer punten links naar recht, en kijk het links ligt
+            if refpts[0][0] > refpts[1][0]:
+                leftpoint, rightpoint = refpts[1], refpts[0]
+            else:
+                leftpoint, rightpoint = refpts[0], refpts[1]
+
+            # Bekijk of het punt links of recht van de lijn links naar rechts ligt
+            if where == "north":
+                return left(pt, [leftpoint, rightpoint])
+            else:
+                return left(pt, [rightpoint, leftpoint])
+
+        if where == "west" or where == "east":
+            # Sorteer punten onder naar boven, en kijk het links ligt
+            if refpts[0][1] > refpts[1][1]:
+                downpoint, toppoint = refpts[1], refpts[0]
+            else:
+                downpoint, toppoint = refpts[0], refpts[1]
+
+            if where == "west":
+                return left(pt, [downpoint, toppoint])
+            else:
+                return left(pt, [toppoint, downpoint])

{pydra_core-0.0.1 → pydra_core-0.0.3}/pydra_core/common/enum.py

@@ -1,63 +1,63 @@
-from enum import Enum
-
-
-class WaterSystem(Enum):
-    """
-    A class representing different water systems in the Netherlands.
-
-    WaterSystem is an enumeration representing a specific water system in The
-    Netherlands and is defined with a unique integer value (WBI2017 Appendix
-    II). The enumeration members include both tidal and non-tidal water
-    systems, such as rivers, lakes, seas, and coastal regions.
-    """
-
-    RHINE_NON_TIDAL = 1
-    MEUSE_NON_TIDAL = 2
-    RHINE_TIDAL = 3
-    MEUSE_TIDAL = 4
-    IJSSEL_DELTA = 5
-    VECHT_DELTA = 6
-    IJSSEL_LAKE = 7
-    MARKER_LAKE = 8
-    WADDEN_SEA_EAST = 9
-    WADDEN_SEA_WEST = 10
-    COAST_NORTH = 11
-    COAST_CENTRAL = 12
-    COAST_SOUTH = 13
-    EASTERN_SCHELDT = 14
-    WESTERN_SCHELDT = 15
-    COAST_DUNES = 16
-    EUROPOORT = 17
-    MEUSE_VALLEY_NON_TIDAL = 18
-    VELUWE_LAKES = 19
-    GREVELINGEN = 20
-    VOLKERAK_ZOOMMEER = 21
-    HOLLANDSCHE_IJSSEL = 22
-    DIEFDIJK = 23
-
-
-class Breakwater(Enum):
-    """
-    Breakwater classes for profiles.
-
-    The 'Breakwater' is an enumeration representing specific types of
-    breakwaters located in front of the profile.
-    """
-
-    NO_BREAKWATER = 0
-    CAISSON = 1
-    VERTICAL_WALL = 2
-    RUBBLE_MOUND = 3
-
-
-class WaveShapeType(Enum):
-    """
-    Different wave form types.
-
-    The 'WaveShapeType' is an enumeration representing specific types of wave
-    forms used for slow stochastics. It can either be a discharge wave or a
-    lake level wave.
-    """
-
-    DISCHARGE = 0
-    LAKE_LEVEL = 1
+from enum import Enum
+
+
+class WaterSystem(Enum):
+    """
+    A class representing different water systems in the Netherlands.
+
+    WaterSystem is an enumeration representing a specific water system in The
+    Netherlands and is defined with a unique integer value (WBI2017 Appendix
+    II). The enumeration members include both tidal and non-tidal water
+    systems, such as rivers, lakes, seas, and coastal regions.
+    """
+
+    RHINE_NON_TIDAL = 1
+    MEUSE_NON_TIDAL = 2
+    RHINE_TIDAL = 3
+    MEUSE_TIDAL = 4
+    IJSSEL_DELTA = 5
+    VECHT_DELTA = 6
+    IJSSEL_LAKE = 7
+    MARKER_LAKE = 8
+    WADDEN_SEA_EAST = 9
+    WADDEN_SEA_WEST = 10
+    COAST_NORTH = 11
+    COAST_CENTRAL = 12
+    COAST_SOUTH = 13
+    EASTERN_SCHELDT = 14
+    WESTERN_SCHELDT = 15
+    COAST_DUNES = 16
+    EUROPOORT = 17
+    MEUSE_VALLEY_NON_TIDAL = 18
+    VELUWE_LAKES = 19
+    GREVELINGEN = 20
+    VOLKERAK_ZOOMMEER = 21
+    HOLLANDSCHE_IJSSEL = 22
+    DIEFDIJK = 23
+
+
+class Breakwater(Enum):
+    """
+    Breakwater classes for profiles.
+
+    The 'Breakwater' is an enumeration representing specific types of
+    breakwaters located in front of the profile.
+    """
+
+    NO_BREAKWATER = 0
+    CAISSON = 1
+    VERTICAL_WALL = 2
+    RUBBLE_MOUND = 3
+
+
+class WaveShapeType(Enum):
+    """
+    Different wave form types.
+
+    The 'WaveShapeType' is an enumeration representing specific types of wave
+    forms used for slow stochastics. It can either be a discharge wave or a
+    lake level wave.
+    """
+
+    DISCHARGE = 0
+    LAKE_LEVEL = 1