pydra-core 0.0.1__py2.py3-none-any.whl → 0.0.2__py2.py3-none-any.whl

pydra_core/location/model/statistics/stochastics/sea_level/sea_level.py

@@ -1,53 +1,53 @@
-import numpy as np
-
-from abc import ABC
-
-
-class SeaLevel(ABC):
-    """
-    Class to describe the sea (water) level statistics.
-    Sea level statistics are conditional on the wind direction.
-    """
-
-    def __init__(self):
-        """
-        Constructor class for the SeaLevel statistics.
-        """
-        self.nm = 0
-        self.m = None
-        self.epm = None
-
-    def __len__(self):
-        """
-        Return the number of sea level discretisations.
-
-        Returns
-        -------
-        int
-            Number of discretisations
-        """
-        return self.nm
-
-    def get_discretisation(self) -> np.ndarray:
-        """
-        Return the sea level discretisation.
-
-        Returns
-        -------
-        np.ndarray
-            1D array with discretisation
-        """
-        return self.m
-
-    def get_exceedance_probability(self) -> np.ndarray:
-        """
-        Return exceedance probility of the sea level, conditional on the wind
-        direction.
-
-        Returns
-        -------
-        np.ndarray
-            A 2D array with the sea level exceedance probability conditional on
-            the wind direction (r x m)
-        """
-        return self.epm
+import numpy as np
+
+from abc import ABC
+
+
+class SeaLevel(ABC):
+    """
+    Class to describe the sea (water) level statistics.
+    Sea level statistics are conditional on the wind direction.
+    """
+
+    def __init__(self):
+        """
+        Constructor class for the SeaLevel statistics.
+        """
+        self.nm = 0
+        self.m = None
+        self.epm = None
+
+    def __len__(self):
+        """
+        Return the number of sea level discretisations.
+
+        Returns
+        -------
+        int
+            Number of discretisations
+        """
+        return self.nm
+
+    def get_discretisation(self) -> np.ndarray:
+        """
+        Return the sea level discretisation.
+
+        Returns
+        -------
+        np.ndarray
+            1D array with discretisation
+        """
+        return self.m
+
+    def get_exceedance_probability(self) -> np.ndarray:
+        """
+        Return exceedance probility of the sea level, conditional on the wind
+        direction.
+
+        Returns
+        -------
+        np.ndarray
+            A 2D array with the sea level exceedance probability conditional on
+            the wind direction (r x m)
+        """
+        return self.epm

pydra_core/location/model/statistics/stochastics/sea_level/sea_level_lower_river.py

@@ -1,93 +1,93 @@
-import numpy as np
-
-from .sea_level import SeaLevel
-from .....settings.settings import Settings
-from ......common.interpolate import Interpolate
-from ......common.probability import ProbabilityFunctions
-from ......io.file_hydranl import FileHydraNL
-
-
-class SeaLevelLowerRiver(SeaLevel):
-    """
-    Class to describe the sea (water) level statistics.
-    Sea level statistics are conditional on the wind direction.
-    """
-
-    def __init__(self, settings: Settings):
-        """
-        Initialise the sea level statistics for Rhine Tidal, Meuse Tidal,
-        EuroPoort, Volkerak-Zoommeer and Hollandsche IJssel.
-
-        Parameters
-        ----------
-        settings : Settings
-            The Settings object
-        """
-        # Inherit
-        super().__init__()
-
-        # Read the exceedance probability of the sea level conditional to the wind direction
-        m, epm = FileHydraNL.read_file_ncolumns(settings.sea_level_probability)
-        m += settings.sea_level_rise
-        nr = epm.shape[1]
-
-        # Correct for the distance between Hoek van Holland and Maasmond
-        self.translation_m = 0.02 - settings.sea_level_rise
-
-        # Equidistant filling vector with seawater levels
-        self.m = ProbabilityFunctions.get_hnl_disc_array(
-            settings.m_min, settings.m_max, settings.m_step
-        )
-
-        # Alloceer matrices
-        self.nm = len(self.m)
-        self.epm = np.zeros([self.nm, nr])
-
-        # Interpolate the conditional exceedance probability of the sea level onto the given grid
-        for ir in range(nr):
-            iszero = epm[:, ir] == 0.0
-            if iszero.any():
-                zeroidx = np.where(iszero)[0][-1]
-
-                # Interpoleer of extrapoleer logaritmisch tot de 0
-                self.epm[:zeroidx, ir] = np.exp(
-                    Interpolate.inextrp1d(
-                        x=self.m[:zeroidx], xp=m[~iszero], fp=np.log(epm[~iszero, ir])
-                    )
-                )
-
-                # Interpoleer of extrapoleer lineair vanaf 0
-                self.epm[zeroidx:, ir] = np.maximum(
-                    0.0, Interpolate.inextrp1d(self.m[zeroidx:], m, epm[:, ir])
-                )
-
-            else:
-                self.epm[:, ir] = np.exp(
-                    Interpolate.inextrp1d(x=self.m, xp=m, fp=np.log(epm[:, ir]))
-                )
-
-        # Limit the upper limit of the excedaance probability to 1.0
-        self.epm = np.minimum(1.0, self.epm)
-
-        # Scaling of the conditional exceedance probability to the used time period
-        if (settings.block_duration != 12.0) and (settings.block_duration is not None):
-            self.epm = 1.0 - (1.0 - self.epm) ** (settings.block_duration / 12.0)
-
-        #  Allocate matrix
-        self.pm = np.zeros((self.nm, nr))
-
-        #  Berekenen kansdichtheid zeewaterstand gegeven de windrichting
-        for ir in range(nr):
-            self.pm[:, ir] = ProbabilityFunctions.probability_density(
-                self.m, self.epm[:, ir]
-            ).density
-
-        #  Inlezen parameters kansverdeling gezamenlijke kansdichtheid zeewaterstand, windsnelheid
-        #  en windrichting
-        _, self.pwinds = FileHydraNL.read_file_ncolumns(
-            settings.wind_sea_level_probability
-        )
-        self.pwinds = self.pwinds.T
-
-        #  Geef twee instellingen van het gegevensblok mee in de structure self
-        self.transitional_wind = settings.transitional_wind
+import numpy as np
+
+from .sea_level import SeaLevel
+from .....settings.settings import Settings
+from ......common.interpolate import Interpolate
+from ......common.probability import ProbabilityFunctions
+from ......io.file_hydranl import FileHydraNL
+
+
+class SeaLevelLowerRiver(SeaLevel):
+    """
+    Class to describe the sea (water) level statistics.
+    Sea level statistics are conditional on the wind direction.
+    """
+
+    def __init__(self, settings: Settings):
+        """
+        Initialise the sea level statistics for Rhine Tidal, Meuse Tidal,
+        EuroPoort, Volkerak-Zoommeer and Hollandsche IJssel.
+
+        Parameters
+        ----------
+        settings : Settings
+            The Settings object
+        """
+        # Inherit
+        super().__init__()
+
+        # Read the exceedance probability of the sea level conditional to the wind direction
+        m, epm = FileHydraNL.read_file_ncolumns(settings.sea_level_probability)
+        m += settings.sea_level_rise
+        nr = epm.shape[1]
+
+        # Correct for the distance between Hoek van Holland and Maasmond
+        self.translation_m = 0.02 - settings.sea_level_rise
+
+        # Equidistant filling vector with seawater levels
+        self.m = ProbabilityFunctions.get_hnl_disc_array(
+            settings.m_min, settings.m_max, settings.m_step
+        )
+
+        # Alloceer matrices
+        self.nm = len(self.m)
+        self.epm = np.zeros([self.nm, nr])
+
+        # Interpolate the conditional exceedance probability of the sea level onto the given grid
+        for ir in range(nr):
+            iszero = epm[:, ir] == 0.0
+            if iszero.any():
+                zeroidx = np.where(iszero)[0][-1]
+
+                # Interpoleer of extrapoleer logaritmisch tot de 0
+                self.epm[:zeroidx, ir] = np.exp(
+                    Interpolate.inextrp1d(
+                        x=self.m[:zeroidx], xp=m[~iszero], fp=np.log(epm[~iszero, ir])
+                    )
+                )
+
+                # Interpoleer of extrapoleer lineair vanaf 0
+                self.epm[zeroidx:, ir] = np.maximum(
+                    0.0, Interpolate.inextrp1d(self.m[zeroidx:], m, epm[:, ir])
+                )
+
+            else:
+                self.epm[:, ir] = np.exp(
+                    Interpolate.inextrp1d(x=self.m, xp=m, fp=np.log(epm[:, ir]))
+                )
+
+        # Limit the upper limit of the excedaance probability to 1.0
+        self.epm = np.minimum(1.0, self.epm)
+
+        # Scaling of the conditional exceedance probability to the used time period
+        if (settings.block_duration != 12.0) and (settings.block_duration is not None):
+            self.epm = 1.0 - (1.0 - self.epm) ** (settings.block_duration / 12.0)
+
+        #  Allocate matrix
+        self.pm = np.zeros((self.nm, nr))
+
+        #  Berekenen kansdichtheid zeewaterstand gegeven de windrichting
+        for ir in range(nr):
+            self.pm[:, ir] = ProbabilityFunctions.probability_density(
+                self.m, self.epm[:, ir]
+            ).density
+
+        #  Inlezen parameters kansverdeling gezamenlijke kansdichtheid zeewaterstand, windsnelheid
+        #  en windrichting
+        _, self.pwinds = FileHydraNL.read_file_ncolumns(
+            settings.wind_sea_level_probability
+        )
+        self.pwinds = self.pwinds.T
+
+        #  Geef twee instellingen van het gegevensblok mee in de structure self
+        self.transitional_wind = settings.transitional_wind

pydra_core/location/model/statistics/stochastics/sea_level/sea_level_point.py

@@ -1,65 +1,65 @@
-import numpy as np
-
-from .sea_level import SeaLevel
-from .....settings.settings import Settings
-from ......common.interpolate import Interpolate
-from ......common.probability import ProbabilityFunctions
-from ......io.file_hydranl import FileHydraNL
-
-
-class SeaLevelPoint(SeaLevel):
-    """
-    Class to describe the sea (water) level statistics.
-    Sea level statistics are conditional on the wind direction.
-    """
-
-    def __init__(self, settings: Settings, epsilon: float = 1.0e-15):
-        """
-        For Eastern Scheldt systems, we base the SeaLevel statistics on one
-        point.
-
-        Parameters
-        ----------
-        settings : Settings
-            The Settings object
-        epsilon : float
-            Maximum exceedance probability to determine the transformation
-            table, used to take correlation into account.
-        """
-        # Inherit
-        super().__init__()
-
-        #  Lees de conditionele overschrijdingskansen van de zeewaterstand gegeven de windrichting
-        m, epm = FileHydraNL.read_file_ncolumns(settings.sea_level_probability)
-        nr = epm.shape[1]
-
-        # Equidistant vullen van vector met zeewaterstanden
-        settings.m_min = settings.m_min if settings.m_min is not None else m[0]
-        self.m = ProbabilityFunctions.get_hnl_disc_array(
-            settings.m_min, settings.m_max, settings.m_step
-        )
-
-        # Alloceer matrices
-        self.nm = len(self.m)
-
-        #  Interpoleer de conditionele overschrijdingskansen van de zeewaterstand gegeven de windrichting naar het gewenste rooster
-        self.epm = np.zeros((self.nm, nr))
-        for ir in range(nr):
-            self.epm[:, ir] = np.maximum(
-                0, np.exp(Interpolate.inextrp1d(self.m, m, np.log(epm[:, ir])))
-            )
-
-        # Adjust for sea level rise
-        self.m = self.m + settings.sea_level_rise
-
-        #  Berekenen kansdichtheid zeewaterstand gegeven de windrichting
-        self.pm = np.zeros((self.nm, nr))
-        for ir in range(nr):
-            self.pm[:, ir] = ProbabilityFunctions.probability_density(
-                self.m, self.epm[:, ir]
-            ).density
-
-        # Bereken de transformatietabel van de OVERschrijdingskansen naar exponentiële ruimte
-        # voor het correlatiemodel van de zeewaterstand en de windsnelheid.
-        # Zie ook vgl. 4.7 van [Geerse, 2012], merk op dat het daar ONDERschrijdingskansen betreft#
-        self.epm_exp = -np.log(np.maximum(self.epm, epsilon))
+import numpy as np
+
+from .sea_level import SeaLevel
+from .....settings.settings import Settings
+from ......common.interpolate import Interpolate
+from ......common.probability import ProbabilityFunctions
+from ......io.file_hydranl import FileHydraNL
+
+
+class SeaLevelPoint(SeaLevel):
+    """
+    Class to describe the sea (water) level statistics.
+    Sea level statistics are conditional on the wind direction.
+    """
+
+    def __init__(self, settings: Settings, epsilon: float = 1.0e-15):
+        """
+        For Eastern Scheldt systems, we base the SeaLevel statistics on one
+        point.
+
+        Parameters
+        ----------
+        settings : Settings
+            The Settings object
+        epsilon : float
+            Maximum exceedance probability to determine the transformation
+            table, used to take correlation into account.
+        """
+        # Inherit
+        super().__init__()
+
+        #  Lees de conditionele overschrijdingskansen van de zeewaterstand gegeven de windrichting
+        m, epm = FileHydraNL.read_file_ncolumns(settings.sea_level_probability)
+        nr = epm.shape[1]
+
+        # Equidistant vullen van vector met zeewaterstanden
+        settings.m_min = settings.m_min if settings.m_min is not None else m[0]
+        self.m = ProbabilityFunctions.get_hnl_disc_array(
+            settings.m_min, settings.m_max, settings.m_step
+        )
+
+        # Alloceer matrices
+        self.nm = len(self.m)
+
+        #  Interpoleer de conditionele overschrijdingskansen van de zeewaterstand gegeven de windrichting naar het gewenste rooster
+        self.epm = np.zeros((self.nm, nr))
+        for ir in range(nr):
+            self.epm[:, ir] = np.maximum(
+                0, np.exp(Interpolate.inextrp1d(self.m, m, np.log(epm[:, ir])))
+            )
+
+        # Adjust for sea level rise
+        self.m = self.m + settings.sea_level_rise
+
+        #  Berekenen kansdichtheid zeewaterstand gegeven de windrichting
+        self.pm = np.zeros((self.nm, nr))
+        for ir in range(nr):
+            self.pm[:, ir] = ProbabilityFunctions.probability_density(
+                self.m, self.epm[:, ir]
+            ).density
+
+        # Bereken de transformatietabel van de OVERschrijdingskansen naar exponentiële ruimte
+        # voor het correlatiemodel van de zeewaterstand en de windsnelheid.
+        # Zie ook vgl. 4.7 van [Geerse, 2012], merk op dat het daar ONDERschrijdingskansen betreft#
+        self.epm_exp = -np.log(np.maximum(self.epm, epsilon))