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

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

@@ -1,108 +1,108 @@
-import numpy as np
-
-from .wave_shape import WaveShape
-from ....settings.settings import Settings
-from .....common.enum import WaveShapeType
-from .....common.interpolate import Interpolate
-from .....io.file_hydranl import FileHydraNL
-
-
-class Discharge:
-    """
-    Class to describe the discharge statistics.
-    """
-
-    def __init__(self, settings: Settings):
-        """
-        Constructor for discharge statistics
-
-        Parameters
-        ----------
-        settings : Settings
-            The Settings object
-        """
-        # Read exceedance probability peak discharge
-        qpeak, epqeak = FileHydraNL.read_file_2columns(settings.discharge_probability)
-
-        # Create grid for peak discharges
-        self.qpeak = np.r_[
-            np.arange(settings.q_min, settings.q_max, settings.q_step), settings.q_max
-        ]
-        self.nqpeak = len(self.qpeak)
-
-        # Inter/extrapolate the exceedance probability of the discharge
-        self.epqpeak = np.exp(
-            Interpolate.inextrp1d(x=self.qpeak, xp=qpeak, fp=np.log(epqeak))
-        )
-
-        #  Transformatie van de tabel met OVERschrijdingskansen naar exponentiële ruimte
-        #  Zie ook vgl. 4.5 van [Geerse, 2003], merk op dat het daar ONDERschrijdingskansen betreft#
-        self.eqpeak_exp = -np.log(self.epqpeak)
-
-        # Init the wave forms
-        self.wave_shape = WaveShape(settings, type=WaveShapeType.DISCHARGE)
-        self.wave_shape.initialise_wave_shapes(self.qpeak)
-
-        # Create grid with blok discharges
-        if settings.q_min < np.min(self.qpeak):
-            step = self.qpeak[1] - self.qpeak[0]
-            self.qblok = np.r_[
-                np.arange(settings.q_min, np.min(self.qpeak), step), self.qpiek
-            ]
-        elif settings.q_min > np.min(self.qpeak):
-            raise ValueError("[ERROR] Q_min is larger than the lowest Q_peak.")
-        else:
-            self.qblok = self.qpeak
-        self.nqblok = len(self.qblok)
-
-        # Calculate the instantaneous exceedance probability
-        inst_epq = self.wave_shape.instantaneous_exceedance_probability(
-            self.epqpeak, self.qblok
-        )
-
-        # Make sure the exceedance probability is not larger than 1 or smaller than 0
-        self.upqblok = np.clip(1.0 - inst_epq, 0.0, 1.0)
-
-    def __len__(self):
-        """
-        Return the number of discharge discretisations.
-
-        Returns
-        -------
-        int
-            Number of discretisations
-        """
-        return self.nqblok
-
-    def get_discretisation(self) -> np.ndarray:
-        """
-        Return the discharge discretisation.
-
-        Returns
-        -------
-        np.ndarray
-            1D array with discretisation
-        """
-        return self.qblok
-
-    def get_exceedance_probability(self) -> np.ndarray:
-        """
-        Return exceedance probility of the discharge
-
-        Returns
-        -------
-        np.ndarray
-            A 1D array with the discharge exceedance probability
-        """
-        return self.upqblok
-
-    def get_wave_shape(self) -> WaveShape:
-        """
-        Return the wave form statistics object.
-
-        Returns
-        -------
-        WaveShape
-            The WaveShape statistics
-        """
-        return self.wave_shape
+import numpy as np
+
+from .wave_shape import WaveShape
+from ....settings.settings import Settings
+from .....common.enum import WaveShapeType
+from .....common.interpolate import Interpolate
+from .....io.file_hydranl import FileHydraNL
+
+
+class Discharge:
+    """
+    Class to describe the discharge statistics.
+    """
+
+    def __init__(self, settings: Settings):
+        """
+        Constructor for discharge statistics
+
+        Parameters
+        ----------
+        settings : Settings
+            The Settings object
+        """
+        # Read exceedance probability peak discharge
+        qpeak, epqeak = FileHydraNL.read_file_2columns(settings.discharge_probability)
+
+        # Create grid for peak discharges
+        self.qpeak = np.r_[
+            np.arange(settings.q_min, settings.q_max, settings.q_step), settings.q_max
+        ]
+        self.nqpeak = len(self.qpeak)
+
+        # Inter/extrapolate the exceedance probability of the discharge
+        self.epqpeak = np.exp(
+            Interpolate.inextrp1d(x=self.qpeak, xp=qpeak, fp=np.log(epqeak))
+        )
+
+        #  Transformatie van de tabel met OVERschrijdingskansen naar exponentiële ruimte
+        #  Zie ook vgl. 4.5 van [Geerse, 2003], merk op dat het daar ONDERschrijdingskansen betreft#
+        self.eqpeak_exp = -np.log(self.epqpeak)
+
+        # Init the wave forms
+        self.wave_shape = WaveShape(settings, type=WaveShapeType.DISCHARGE)
+        self.wave_shape.initialise_wave_shapes(self.qpeak)
+
+        # Create grid with blok discharges
+        if settings.q_min < np.min(self.qpeak):
+            step = self.qpeak[1] - self.qpeak[0]
+            self.qblok = np.r_[
+                np.arange(settings.q_min, np.min(self.qpeak), step), self.qpiek
+            ]
+        elif settings.q_min > np.min(self.qpeak):
+            raise ValueError("[ERROR] Q_min is larger than the lowest Q_peak.")
+        else:
+            self.qblok = self.qpeak
+        self.nqblok = len(self.qblok)
+
+        # Calculate the instantaneous exceedance probability
+        inst_epq = self.wave_shape.instantaneous_exceedance_probability(
+            self.epqpeak, self.qblok
+        )
+
+        # Make sure the exceedance probability is not larger than 1 or smaller than 0
+        self.upqblok = np.clip(1.0 - inst_epq, 0.0, 1.0)
+
+    def __len__(self):
+        """
+        Return the number of discharge discretisations.
+
+        Returns
+        -------
+        int
+            Number of discretisations
+        """
+        return self.nqblok
+
+    def get_discretisation(self) -> np.ndarray:
+        """
+        Return the discharge discretisation.
+
+        Returns
+        -------
+        np.ndarray
+            1D array with discretisation
+        """
+        return self.qblok
+
+    def get_exceedance_probability(self) -> np.ndarray:
+        """
+        Return exceedance probility of the discharge
+
+        Returns
+        -------
+        np.ndarray
+            A 1D array with the discharge exceedance probability
+        """
+        return self.upqblok
+
+    def get_wave_shape(self) -> WaveShape:
+        """
+        Return the wave form statistics object.
+
+        Returns
+        -------
+        WaveShape
+            The WaveShape statistics
+        """
+        return self.wave_shape

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

@@ -1,55 +1,55 @@
-import numpy as np
-
-from .....io.file_hydranl import FileHydraNL
-
-
-class DiscreteProbability:
-    """
-    Class to describe the discrete statistics.
-    """
-
-    def __init__(self, statistics_file_path: str):
-        """
-        Constructor class for the discrete statistics.
-
-        Parameters
-        ----------
-        statistics_file_path : str
-            Path to the statistics file
-        """
-        self.discretisation, self.probability = FileHydraNL.read_file_2columns(
-            statistics_file_path
-        )
-
-    def __len__(self):
-        """
-        Return the number discretisations.
-
-        Returns
-        -------
-        int
-            Number of discretisations
-        """
-        return len(self.discretisation)
-
-    def get_discretisation(self) -> np.ndarray:
-        """
-        Return the discretisation.
-
-        Returns
-        -------
-        np.ndarray
-            1D array with discretisation
-        """
-        return self.discretisation
-
-    def get_probability(self) -> np.ndarray:
-        """
-        Return the probability of each discretisation.
-
-        Returns
-        -------
-        np.ndarray
-            1D array with probabilities
-        """
-        return self.probability
+import numpy as np
+
+from .....io.file_hydranl import FileHydraNL
+
+
+class DiscreteProbability:
+    """
+    Class to describe the discrete statistics.
+    """
+
+    def __init__(self, statistics_file_path: str):
+        """
+        Constructor class for the discrete statistics.
+
+        Parameters
+        ----------
+        statistics_file_path : str
+            Path to the statistics file
+        """
+        self.discretisation, self.probability = FileHydraNL.read_file_2columns(
+            statistics_file_path
+        )
+
+    def __len__(self):
+        """
+        Return the number discretisations.
+
+        Returns
+        -------
+        int
+            Number of discretisations
+        """
+        return len(self.discretisation)
+
+    def get_discretisation(self) -> np.ndarray:
+        """
+        Return the discretisation.
+
+        Returns
+        -------
+        np.ndarray
+            1D array with discretisation
+        """
+        return self.discretisation
+
+    def get_probability(self) -> np.ndarray:
+        """
+        Return the probability of each discretisation.
+
+        Returns
+        -------
+        np.ndarray
+            1D array with probabilities
+        """
+        return self.probability

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

@@ -1,158 +1,158 @@
-import numpy as np
-
-from .wave_shape import WaveShape
-from ....settings.settings import Settings
-from .....common.enum import WaterSystem, WaveShapeType
-from .....common.interpolate import Interpolate
-from .....io.file_hydranl import FileHydraNL
-
-
-class LakeLevel:
-    """
-    Class to describe the lake (water) level statistics.
-    """
-
-    def __init__(self, settings: Settings):
-        """
-        Constructor class for LakeLevel statistics.
-
-        Parameters
-        ----------
-        settings : Settings
-            The Settings object
-        """
-        # Read exceedance probability peak lake level
-        apeak, epapeak = FileHydraNL.read_file_2columns(settings.lake_level_probability)
-
-        # Adjust for lake level rise
-        apeak += settings.lake_level_rise
-
-        # Lowest lake level
-        a_min_piek = max(apeak[0] - settings.lake_level_rise, settings.a_min)
-
-        # Creeer rooster met meerpeilen voor de trapezia
-        self.apeak = np.r_[
-            np.arange(a_min_piek, settings.a_max, settings.a_step), settings.a_max
-        ]
-        self.napeak = len(self.apeak)
-
-        # Als de meerpeilen bekend zijn kunnen de trapezia worden geïnitialiseerd
-        # (Vul de vector met meerpeilen)
-        self.wave_shape = WaveShape(settings, type=WaveShapeType.LAKE_LEVEL)
-        self.wave_shape.initialise_wave_shapes(
-            self.apeak, climate_change=settings.lake_level_rise
-        )
-
-        # Creeer rooster met meerpeilen voor het opdelen van de golfvormen in blokken
-        # TODO self.invoergeg.m_min #= MLAAGST? Moet dit dan kol1.min() zijn?
-        # self.mblok = roosterblokken(self.invoergeg.m_min, self.mpiek)
-        self.ablok = self.apeak.copy()
-        self.nablok = len(self.ablok)
-
-        # Blaas de tabel met overschrijdingskansen voor het meerpeil op
-        # De interpolatie wordt logaritmische uitgevoerd.
-        self.epapeak = np.exp(
-            Interpolate.inextrp1d(x=self.apeak, xp=apeak, fp=np.log(epapeak))
-        )
-        self.epapeak[self.epapeak > 1] = 1.0
-
-        # IJssel-Vechtdelta and VZM related
-        if settings.watersystem in [
-            WaterSystem.IJSSEL_DELTA,
-            WaterSystem.VECHT_DELTA,
-            WaterSystem.VOLKERAK_ZOOMMEER,
-        ]:
-            # Lokale paramters
-            N = 376
-
-            # Geef verwachtingswaarde en standaarddeviatie van de normale verdeling in de getransformeerde ruimte een waarde
-            mu = 0.0
-            sigma = settings.sigma_aq  # invoergeg.sigma_mq(ig)
-
-            # Zet de gegevens voor de verfijnde interpolatietabel (de y-waarden, ofwel de K_sigma(s) uit vgl. 4.7 van [Geerse, 2003.129x]
-            # Bereken voor elke y-waarde de integraal 4.3 [Geerse, 2003]
-            f_y_k = np.linspace(-2 - 4 * sigma, 20 + 4 * sigma, N)
-
-            # Verfijnde tabel klaarzetten van de cumulatieve verdelingsfunctie onder transformatie van s naar y
-            # Zie ook vgl. 4.3 van [Geerse, 2003]
-
-            # Maak de vector met y-waarden:
-            # Bereken voor elke y-waarde de integraal 4.3 [Geerse, 2003]
-            f_y_sigma = self.wave_shape.cum_norm_s_naar_y(f_y_k, mu, sigma)
-
-            # Kansverdeling schalen of de hoogste ONDERschrijdingskans gelijk stellen aan 1
-            if f_y_sigma[-1] > 1.0:
-                f_y_sigma /= f_y_sigma[-1]
-            else:
-                f_y_sigma[-1] = 1.0
-
-            for i in range(N):
-                if f_y_sigma[i] > 0:
-                    D = i
-                    break
-
-            # Een ONDERschrijdingskans gelijk aan 0.0 mag worden meegenomen.
-            if D > 0:
-                D -= 1
-
-            self.k_apeak = Interpolate.inextrp1d(
-                x=1 - self.epapeak, xp=f_y_sigma[D:], fp=f_y_k[D:]
-            )
-
-        #  Bereken de momentane overschrijdingskansen van het meerpeil
-        self.mom_ovkans_a = self.wave_shape.instantaneous_exceedance_probability(
-            self.epapeak, self.ablok
-        )
-
-        # Transition
-        if (settings.transition_lake_wave_shape is not None) and (
-            settings.transition_lake_wave_shape != 0.0
-        ):
-            self.wave_shape.transition_wave(settings.transition_lake_wave_shape)
-
-        # Filter overschrijdingskansen die kleiner dan 0 of grote dan 1 zijn. Dit kan voorkomen door floating point precision
-        self.upablok = np.clip(1.0 - self.mom_ovkans_a, 0.0, 1.0)
-
-    def __len__(self):
-        """
-        Return the number of discharge discretisations.
-
-        Returns
-        -------
-        int
-            Number of discretisations
-        """
-        return self.nablok
-
-    def get_discretisation(self) -> np.ndarray:
-        """
-        Return the discharge discretisation.
-
-        Returns
-        -------
-        np.ndarray
-            1D array with discretisation
-        """
-        return self.ablok
-
-    def get_exceedance_probability(self) -> np.ndarray:
-        """
-        Return exceedance probility of the discharge
-
-        Returns
-        -------
-        np.ndarray
-            A 1D array with the discharge exceedance probability
-        """
-        return self.upablok
-
-    def get_wave_shape(self) -> WaveShape:
-        """
-        Return the wave form statistics object.
-
-        Returns
-        -------
-        WaveShape
-            The WaveShape statistics
-        """
-        return self.wave_shape
+import numpy as np
+
+from .wave_shape import WaveShape
+from ....settings.settings import Settings
+from .....common.enum import WaterSystem, WaveShapeType
+from .....common.interpolate import Interpolate
+from .....io.file_hydranl import FileHydraNL
+
+
+class LakeLevel:
+    """
+    Class to describe the lake (water) level statistics.
+    """
+
+    def __init__(self, settings: Settings):
+        """
+        Constructor class for LakeLevel statistics.
+
+        Parameters
+        ----------
+        settings : Settings
+            The Settings object
+        """
+        # Read exceedance probability peak lake level
+        apeak, epapeak = FileHydraNL.read_file_2columns(settings.lake_level_probability)
+
+        # Adjust for lake level rise
+        apeak += settings.lake_level_rise
+
+        # Lowest lake level
+        a_min_piek = max(apeak[0] - settings.lake_level_rise, settings.a_min)
+
+        # Creeer rooster met meerpeilen voor de trapezia
+        self.apeak = np.r_[
+            np.arange(a_min_piek, settings.a_max, settings.a_step), settings.a_max
+        ]
+        self.napeak = len(self.apeak)
+
+        # Als de meerpeilen bekend zijn kunnen de trapezia worden geïnitialiseerd
+        # (Vul de vector met meerpeilen)
+        self.wave_shape = WaveShape(settings, type=WaveShapeType.LAKE_LEVEL)
+        self.wave_shape.initialise_wave_shapes(
+            self.apeak, climate_change=settings.lake_level_rise
+        )
+
+        # Creeer rooster met meerpeilen voor het opdelen van de golfvormen in blokken
+        # TODO self.invoergeg.m_min #= MLAAGST? Moet dit dan kol1.min() zijn?
+        # self.mblok = roosterblokken(self.invoergeg.m_min, self.mpiek)
+        self.ablok = self.apeak.copy()
+        self.nablok = len(self.ablok)
+
+        # Blaas de tabel met overschrijdingskansen voor het meerpeil op
+        # De interpolatie wordt logaritmische uitgevoerd.
+        self.epapeak = np.exp(
+            Interpolate.inextrp1d(x=self.apeak, xp=apeak, fp=np.log(epapeak))
+        )
+        self.epapeak[self.epapeak > 1] = 1.0
+
+        # IJssel-Vechtdelta and VZM related
+        if settings.watersystem in [
+            WaterSystem.IJSSEL_DELTA,
+            WaterSystem.VECHT_DELTA,
+            WaterSystem.VOLKERAK_ZOOMMEER,
+        ]:
+            # Lokale paramters
+            N = 376
+
+            # Geef verwachtingswaarde en standaarddeviatie van de normale verdeling in de getransformeerde ruimte een waarde
+            mu = 0.0
+            sigma = settings.sigma_aq  # invoergeg.sigma_mq(ig)
+
+            # Zet de gegevens voor de verfijnde interpolatietabel (de y-waarden, ofwel de K_sigma(s) uit vgl. 4.7 van [Geerse, 2003.129x]
+            # Bereken voor elke y-waarde de integraal 4.3 [Geerse, 2003]
+            f_y_k = np.linspace(-2 - 4 * sigma, 20 + 4 * sigma, N)
+
+            # Verfijnde tabel klaarzetten van de cumulatieve verdelingsfunctie onder transformatie van s naar y
+            # Zie ook vgl. 4.3 van [Geerse, 2003]
+
+            # Maak de vector met y-waarden:
+            # Bereken voor elke y-waarde de integraal 4.3 [Geerse, 2003]
+            f_y_sigma = self.wave_shape.cum_norm_s_naar_y(f_y_k, mu, sigma)
+
+            # Kansverdeling schalen of de hoogste ONDERschrijdingskans gelijk stellen aan 1
+            if f_y_sigma[-1] > 1.0:
+                f_y_sigma /= f_y_sigma[-1]
+            else:
+                f_y_sigma[-1] = 1.0
+
+            for i in range(N):
+                if f_y_sigma[i] > 0:
+                    D = i
+                    break
+
+            # Een ONDERschrijdingskans gelijk aan 0.0 mag worden meegenomen.
+            if D > 0:
+                D -= 1
+
+            self.k_apeak = Interpolate.inextrp1d(
+                x=1 - self.epapeak, xp=f_y_sigma[D:], fp=f_y_k[D:]
+            )
+
+        #  Bereken de momentane overschrijdingskansen van het meerpeil
+        self.mom_ovkans_a = self.wave_shape.instantaneous_exceedance_probability(
+            self.epapeak, self.ablok
+        )
+
+        # Transition
+        if (settings.transition_lake_wave_shape is not None) and (
+            settings.transition_lake_wave_shape != 0.0
+        ):
+            self.wave_shape.transition_wave(settings.transition_lake_wave_shape)
+
+        # Filter overschrijdingskansen die kleiner dan 0 of grote dan 1 zijn. Dit kan voorkomen door floating point precision
+        self.upablok = np.clip(1.0 - self.mom_ovkans_a, 0.0, 1.0)
+
+    def __len__(self):
+        """
+        Return the number of discharge discretisations.
+
+        Returns
+        -------
+        int
+            Number of discretisations
+        """
+        return self.nablok
+
+    def get_discretisation(self) -> np.ndarray:
+        """
+        Return the discharge discretisation.
+
+        Returns
+        -------
+        np.ndarray
+            1D array with discretisation
+        """
+        return self.ablok
+
+    def get_exceedance_probability(self) -> np.ndarray:
+        """
+        Return exceedance probility of the discharge
+
+        Returns
+        -------
+        np.ndarray
+            A 1D array with the discharge exceedance probability
+        """
+        return self.upablok
+
+    def get_wave_shape(self) -> WaveShape:
+        """
+        Return the wave form statistics object.
+
+        Returns
+        -------
+        WaveShape
+            The WaveShape statistics
+        """
+        return self.wave_shape