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

pydra_core/location/model/statistics/statistics.py

@@ -1,171 +1,171 @@
-from abc import ABC, abstractmethod
-
-from .stochastics.barrier.barrier import Barrier
-from .stochastics.barrier.no_barrier import NoBarrier
-from .stochastics.discharge import Discharge
-from .stochastics.discrete_probability import DiscreteProbability
-from .stochastics.lake_level import LakeLevel
-from .stochastics.model_uncertainty import ModelUncertainty
-from .stochastics.sea_level.sea_level import SeaLevel
-from .stochastics.sigma_function import SigmaFunction
-
-# from .stochastics.wave_shape import WaveShape
-from .stochastics.wind_speed import WindSpeed
-from ...settings.settings import Settings
-
-
-class Statistics(ABC):
-    """
-    Statistics abstract base class
-    Used to define statistic classes for different water systems
-    """
-
-    @abstractmethod
-    def __init__(self, settings: Settings):
-        # Save settings
-        self.settings: Settings = settings
-
-        # Statistics, required
-        self.wind_direction: DiscreteProbability = None
-        self.wind_speed: WindSpeed = None
-        self.model_uncertainties: ModelUncertainty = None
-
-        # Coast
-        self.barrier: Barrier = NoBarrier()
-        self.phase_surge_tide: DiscreteProbability = None
-        self.sea_level: SeaLevel = None
-        self.storm_surge_duration: DiscreteProbability = None
-
-        # Lake
-        self.lake_level: LakeLevel = None
-
-        # Other
-        self.sigma_function: SigmaFunction = None
-
-        # River
-        self.discharge: Discharge = None
-
-        # Discrete, slow, fast stochatics
-        # TODO: Replace with framework
-        self.stochastics_discrete = {}
-        self.stochastics_fast = {}
-        self.stochastics_slow = {}
-
-    @abstractmethod
-    def calculate_probability(
-        self, wind_direction: float, closing_situation: int = 1, given: list = []
-    ):
-        """
-        TODO
-        """
-        pass
-
-    def get_wind_directions(self) -> DiscreteProbability:
-        """
-        Returns the wind directions statistics object.
-
-        Returns
-        -------
-        WindDirection
-            The wind direction statistics
-        """
-        return self.wind_direction
-
-    def get_wind_speed(self) -> WindSpeed:
-        """
-        Returns the wind statistics object.
-
-        Returns
-        -------
-        WindSpeed
-            The wind speed statistics
-        """
-        return self.wind_speed
-
-    def get_model_uncertainties(self) -> ModelUncertainty:
-        """
-        Returns the model uncertainty statistics object.
-
-        Returns
-        -------
-        ModelUncertainty
-            The ModelUncertainty statistics
-        """
-        return self.model_uncertainties
-
-    def get_barrier(self) -> Barrier:
-        """
-        Returns the barrier statistics object.
-
-        Returns
-        -------
-        Barrier
-            The barrier statistics object
-        """
-        return self.barrier
-
-    def get_discharge(self) -> Discharge:
-        """
-        Returns the discharge statistics object.
-
-        Returns
-        -------
-        Discharge
-            The discharge statistics object
-        """
-        return self.discharge
-
-    def get_lake_level(self) -> LakeLevel:
-        """
-        Returns the lake level statistics object.
-
-        Returns
-        -------
-        LakeLevel
-            The LakeLevel statistics
-        """
-        return self.lake_level
-
-    def get_phase_surge_tide(self) -> DiscreteProbability:
-        """
-        Returns the fase surge tide statistics object.
-
-        Returns
-        -------
-        FaseSurgeTide
-            The FaseSurgeTide statistics
-        """
-        return self.phase_surge_tide
-
-    def get_sea_level(self) -> SeaLevel:
-        """
-        Returns the sea level statistics object.
-
-        Returns
-        -------
-        SeaLevel
-            The SeaLevel statistics
-        """
-        return self.sea_level
-
-    def get_sigma_function(self) -> SigmaFunction:
-        """
-        Returns the sigma function statistics object.
-
-        Returns
-        -------
-        SigmaFunction
-            The SigmaFunction statistics
-        """
-        return self.sigma_function
-
-    def get_storm_surge_duration(self) -> DiscreteProbability:
-        """
-        Returns the storm surge duration statistics object.
-
-        Returns
-        -------
-        StormSurgeDuration
-            The StormSurgeDuration statistics
-        """
-        return self.storm_surge_duration
+from abc import ABC, abstractmethod
+
+from .stochastics.barrier.barrier import Barrier
+from .stochastics.barrier.no_barrier import NoBarrier
+from .stochastics.discharge import Discharge
+from .stochastics.discrete_probability import DiscreteProbability
+from .stochastics.lake_level import LakeLevel
+from .stochastics.model_uncertainty import ModelUncertainty
+from .stochastics.sea_level.sea_level import SeaLevel
+from .stochastics.sigma_function import SigmaFunction
+
+# from .stochastics.wave_shape import WaveShape
+from .stochastics.wind_speed import WindSpeed
+from ...settings.settings import Settings
+
+
+class Statistics(ABC):
+    """
+    Statistics abstract base class
+    Used to define statistic classes for different water systems
+    """
+
+    @abstractmethod
+    def __init__(self, settings: Settings):
+        # Save settings
+        self.settings: Settings = settings
+
+        # Statistics, required
+        self.wind_direction: DiscreteProbability = None
+        self.wind_speed: WindSpeed = None
+        self.model_uncertainties: ModelUncertainty = None
+
+        # Coast
+        self.barrier: Barrier = NoBarrier()
+        self.phase_surge_tide: DiscreteProbability = None
+        self.sea_level: SeaLevel = None
+        self.storm_surge_duration: DiscreteProbability = None
+
+        # Lake
+        self.lake_level: LakeLevel = None
+
+        # Other
+        self.sigma_function: SigmaFunction = None
+
+        # River
+        self.discharge: Discharge = None
+
+        # Discrete, slow, fast stochatics
+        # TODO: Replace with framework
+        self.stochastics_discrete = {}
+        self.stochastics_fast = {}
+        self.stochastics_slow = {}
+
+    @abstractmethod
+    def calculate_probability(
+        self, wind_direction: float, closing_situation: int = 1, given: list = []
+    ):
+        """
+        TODO
+        """
+        pass
+
+    def get_wind_directions(self) -> DiscreteProbability:
+        """
+        Returns the wind directions statistics object.
+
+        Returns
+        -------
+        WindDirection
+            The wind direction statistics
+        """
+        return self.wind_direction
+
+    def get_wind_speed(self) -> WindSpeed:
+        """
+        Returns the wind statistics object.
+
+        Returns
+        -------
+        WindSpeed
+            The wind speed statistics
+        """
+        return self.wind_speed
+
+    def get_model_uncertainties(self) -> ModelUncertainty:
+        """
+        Returns the model uncertainty statistics object.
+
+        Returns
+        -------
+        ModelUncertainty
+            The ModelUncertainty statistics
+        """
+        return self.model_uncertainties
+
+    def get_barrier(self) -> Barrier:
+        """
+        Returns the barrier statistics object.
+
+        Returns
+        -------
+        Barrier
+            The barrier statistics object
+        """
+        return self.barrier
+
+    def get_discharge(self) -> Discharge:
+        """
+        Returns the discharge statistics object.
+
+        Returns
+        -------
+        Discharge
+            The discharge statistics object
+        """
+        return self.discharge
+
+    def get_lake_level(self) -> LakeLevel:
+        """
+        Returns the lake level statistics object.
+
+        Returns
+        -------
+        LakeLevel
+            The LakeLevel statistics
+        """
+        return self.lake_level
+
+    def get_phase_surge_tide(self) -> DiscreteProbability:
+        """
+        Returns the fase surge tide statistics object.
+
+        Returns
+        -------
+        FaseSurgeTide
+            The FaseSurgeTide statistics
+        """
+        return self.phase_surge_tide
+
+    def get_sea_level(self) -> SeaLevel:
+        """
+        Returns the sea level statistics object.
+
+        Returns
+        -------
+        SeaLevel
+            The SeaLevel statistics
+        """
+        return self.sea_level
+
+    def get_sigma_function(self) -> SigmaFunction:
+        """
+        Returns the sigma function statistics object.
+
+        Returns
+        -------
+        SigmaFunction
+            The SigmaFunction statistics
+        """
+        return self.sigma_function
+
+    def get_storm_surge_duration(self) -> DiscreteProbability:
+        """
+        Returns the storm surge duration statistics object.
+
+        Returns
+        -------
+        StormSurgeDuration
+            The StormSurgeDuration statistics
+        """
+        return self.storm_surge_duration

pydra_core/location/model/statistics/statistics_factory.py

@@ -1,89 +1,89 @@
-from .statistics import Statistics
-from .water_systems.statistics_coast import StatisticsCoast
-from .water_systems.statistics_eastern_scheldt import StatisticsEasternScheldt
-from .water_systems.statistics_ijssel_vechtdelta import StatisticsIJsselVechtdelta
-from .water_systems.statistics_lake import StatisticsLake
-from .water_systems.statistics_lower_river import StatisticsLowerRiver
-from .water_systems.statistics_upper_river import StatisticsUpperRiver
-from ...settings.settings import Settings
-from ....common.enum import WaterSystem
-
-
-class StatisticsFactory:
-    """
-    A factory class to generate the right Statistics object for a given Settings object.
-
-    Attributes
-    ----------
-    WATER_SYSTEM_STATISTICS_MAP : dict
-        A dictionary containing the corresponding Statistics class for a WaterSystem
-    """
-
-    # Dictionary with Statistic classes for each WaterSystem
-    WATER_SYSTEM_STATISTICS_MAP = {
-        # Upper River
-        WaterSystem.RHINE_NON_TIDAL: StatisticsUpperRiver,
-        WaterSystem.MEUSE_NON_TIDAL: StatisticsUpperRiver,
-        WaterSystem.MEUSE_VALLEY_NON_TIDAL: StatisticsUpperRiver,
-        # Lower River
-        WaterSystem.RHINE_TIDAL: StatisticsLowerRiver,
-        WaterSystem.MEUSE_TIDAL: StatisticsLowerRiver,
-        # TODO: WaterSystem.EUROPOORT
-        # Coast
-        WaterSystem.WADDEN_SEA_EAST: StatisticsCoast,
-        WaterSystem.WADDEN_SEA_WEST: StatisticsCoast,
-        WaterSystem.COAST_NORTH: StatisticsCoast,
-        WaterSystem.COAST_CENTRAL: StatisticsCoast,
-        WaterSystem.COAST_SOUTH: StatisticsCoast,
-        WaterSystem.WESTERN_SCHELDT: StatisticsCoast,
-        # Eastern Scheldt
-        WaterSystem.EASTERN_SCHELDT: StatisticsEasternScheldt,
-        # Lakes
-        WaterSystem.IJSSEL_LAKE: StatisticsLake,
-        WaterSystem.MARKER_LAKE: StatisticsLake,
-        # TODO: WaterSystem.VELUWE_LAKES
-        # TODO: WaterSystem.GREVELINGEN
-        # IJssel-Vecht Delta
-        WaterSystem.VECHT_DELTA: StatisticsIJsselVechtdelta,
-        WaterSystem.IJSSEL_DELTA: StatisticsIJsselVechtdelta,
-        # Volkerak-Zoommeer
-        # TODO: WaterSystem.VOLKERAK_ZOOMMEER
-        # Hollandsche IJssel
-        # TODO: WaterSystem.HOLLANDSCHE_IJSSEL
-        # Other
-        # WaterSystem.COAST_DUNES
-        # WaterSystem.DIEFDIJK
-    }
-
-    @staticmethod
-    def get_statistics(settings: Settings) -> Statistics:
-        """
-        Returns the Statistics object for the specified water system.
-
-        Parameters
-        ----------
-        settings : Settings
-            A Settings object to get statistics for.
-
-        Returns
-        -------
-        Statistics
-            A Statistics object for the specified water system.
-
-        Raises
-        ------
-        NotImplementedError
-            If statistics for the specified water system are not implemented.
-        """
-        # Obtain the right Statistics class
-        statistics_class = StatisticsFactory.WATER_SYSTEM_STATISTICS_MAP.get(
-            settings.watersystem
-        )
-
-        # Return if the class is found, otherwise raise an error
-        if statistics_class:
-            return statistics_class(settings)
-        else:
-            raise NotImplementedError(
-                f"[ERROR] Statistics for '{settings.watersystem.name}' not implemented (ID: {settings.watersystem.value})"
-            )
+from .statistics import Statistics
+from .water_systems.statistics_coast import StatisticsCoast
+from .water_systems.statistics_eastern_scheldt import StatisticsEasternScheldt
+from .water_systems.statistics_ijssel_vechtdelta import StatisticsIJsselVechtdelta
+from .water_systems.statistics_lake import StatisticsLake
+from .water_systems.statistics_lower_river import StatisticsLowerRiver
+from .water_systems.statistics_upper_river import StatisticsUpperRiver
+from ...settings.settings import Settings
+from ....common.enum import WaterSystem
+
+
+class StatisticsFactory:
+    """
+    A factory class to generate the right Statistics object for a given Settings object.
+
+    Attributes
+    ----------
+    WATER_SYSTEM_STATISTICS_MAP : dict
+        A dictionary containing the corresponding Statistics class for a WaterSystem
+    """
+
+    # Dictionary with Statistic classes for each WaterSystem
+    WATER_SYSTEM_STATISTICS_MAP = {
+        # Upper River
+        WaterSystem.RHINE_NON_TIDAL: StatisticsUpperRiver,
+        WaterSystem.MEUSE_NON_TIDAL: StatisticsUpperRiver,
+        WaterSystem.MEUSE_VALLEY_NON_TIDAL: StatisticsUpperRiver,
+        # Lower River
+        WaterSystem.RHINE_TIDAL: StatisticsLowerRiver,
+        WaterSystem.MEUSE_TIDAL: StatisticsLowerRiver,
+        # TODO: WaterSystem.EUROPOORT
+        # Coast
+        WaterSystem.WADDEN_SEA_EAST: StatisticsCoast,
+        WaterSystem.WADDEN_SEA_WEST: StatisticsCoast,
+        WaterSystem.COAST_NORTH: StatisticsCoast,
+        WaterSystem.COAST_CENTRAL: StatisticsCoast,
+        WaterSystem.COAST_SOUTH: StatisticsCoast,
+        WaterSystem.WESTERN_SCHELDT: StatisticsCoast,
+        # Eastern Scheldt
+        WaterSystem.EASTERN_SCHELDT: StatisticsEasternScheldt,
+        # Lakes
+        WaterSystem.IJSSEL_LAKE: StatisticsLake,
+        WaterSystem.MARKER_LAKE: StatisticsLake,
+        # TODO: WaterSystem.VELUWE_LAKES
+        # TODO: WaterSystem.GREVELINGEN
+        # IJssel-Vecht Delta
+        WaterSystem.VECHT_DELTA: StatisticsIJsselVechtdelta,
+        WaterSystem.IJSSEL_DELTA: StatisticsIJsselVechtdelta,
+        # Volkerak-Zoommeer
+        # TODO: WaterSystem.VOLKERAK_ZOOMMEER
+        # Hollandsche IJssel
+        # TODO: WaterSystem.HOLLANDSCHE_IJSSEL
+        # Other
+        # WaterSystem.COAST_DUNES
+        # WaterSystem.DIEFDIJK
+    }
+
+    @staticmethod
+    def get_statistics(settings: Settings) -> Statistics:
+        """
+        Returns the Statistics object for the specified water system.
+
+        Parameters
+        ----------
+        settings : Settings
+            A Settings object to get statistics for.
+
+        Returns
+        -------
+        Statistics
+            A Statistics object for the specified water system.
+
+        Raises
+        ------
+        NotImplementedError
+            If statistics for the specified water system are not implemented.
+        """
+        # Obtain the right Statistics class
+        statistics_class = StatisticsFactory.WATER_SYSTEM_STATISTICS_MAP.get(
+            settings.watersystem
+        )
+
+        # Return if the class is found, otherwise raise an error
+        if statistics_class:
+            return statistics_class(settings)
+        else:
+            raise NotImplementedError(
+                f"[ERROR] Statistics for '{settings.watersystem.name}' not implemented (ID: {settings.watersystem.value})"
+            )

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

@@ -1,43 +1,43 @@
-import numpy as np
-
-from abc import ABC, abstractmethod
-
-from ..discrete_probability import DiscreteProbability
-from .....settings.settings import Settings
-
-
-class Barrier(ABC):
-    def __init__(self, settings: Settings, wind_direction: DiscreteProbability):
-        # Save key information
-        self.settings = settings
-        self.wind_direction = wind_direction
-        self.k = None
-        self.nk = None
-
-    def __len__(self):
-        """
-        Return the number of barrier discretisations.
-
-        Returns
-        -------
-        int
-            Number of discretisations
-        """
-        return self.nk
-
-    def get_discretisation(self) -> np.ndarray:
-        """
-        Return the barrier discretisation.
-
-        Returns
-        -------
-        np.ndarray
-            1D array with discretisation
-        """
-        return self.k
-
-    @abstractmethod
-    def calculate_closing_probability(
-        self, wind_direction: float, closing_situation: int
-    ) -> np.ndarray:
-        pass
+import numpy as np
+
+from abc import ABC, abstractmethod
+
+from ..discrete_probability import DiscreteProbability
+from .....settings.settings import Settings
+
+
+class Barrier(ABC):
+    def __init__(self, settings: Settings, wind_direction: DiscreteProbability):
+        # Save key information
+        self.settings = settings
+        self.wind_direction = wind_direction
+        self.k = None
+        self.nk = None
+
+    def __len__(self):
+        """
+        Return the number of barrier discretisations.
+
+        Returns
+        -------
+        int
+            Number of discretisations
+        """
+        return self.nk
+
+    def get_discretisation(self) -> np.ndarray:
+        """
+        Return the barrier discretisation.
+
+        Returns
+        -------
+        np.ndarray
+            1D array with discretisation
+        """
+        return self.k
+
+    @abstractmethod
+    def calculate_closing_probability(
+        self, wind_direction: float, closing_situation: int
+    ) -> np.ndarray:
+        pass