simapy 5.0.0.dev0__tar.gz → 5.4.0__tar.gz

simapy-5.4.0/PKG-INFO

@@ -0,0 +1,47 @@
+Metadata-Version: 2.4
+Name: simapy
+Version: 5.4.0
+Summary: Python utilities for SIMA
+Author: SINTEF Ocean
+License: MIT License
+Project-URL: Homepage, https://github.com/SINTEF/simapy
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: dmtpy==0.3.6
+Requires-Dist: numpy
+Requires-Dist: simapy-results==5.4.0
+Requires-Dist: tqdm
+Provides-Extra: pandas
+Requires-Dist: simapy-results[pandas]==5.4.0; extra == "pandas"
+Provides-Extra: hdf5
+Requires-Dist: simapy-results[hdf5]==5.4.0; extra == "hdf5"
+Provides-Extra: all
+Requires-Dist: simapy[hdf5,pandas]; extra == "all"
+Dynamic: license-file
+
+SIMAPy - Python utilities for SIMA
+=================================================================
+
+Build SIMA models in Python, run [SIMA](https://sima.sintef.no) without its user interface,
+and read the results back as numpy arrays and pandas frames.
+
+## Installation
+
+```bash
+pip install simapy[all]
+```
+
+Use the SIMAPy version that matches SIMA: SIMAPy 5.4 reads and writes the models of SIMA 5.4.
+
+## Documentation
+
+The [SIMAPy documentation](https://sima.sintef.no/docs/5.4/simapy/) is part of the SIMA
+documentation, with a user guide and examples to download.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

simapy-5.4.0/README.md

@@ -0,0 +1,22 @@
+SIMAPy - Python utilities for SIMA
+=================================================================
+
+Build SIMA models in Python, run [SIMA](https://sima.sintef.no) without its user interface,
+and read the results back as numpy arrays and pandas frames.
+
+## Installation
+
+```bash
+pip install simapy[all]
+```
+
+Use the SIMAPy version that matches SIMA: SIMAPy 5.4 reads and writes the models of SIMA 5.4.
+
+## Documentation
+
+The [SIMAPy documentation](https://sima.sintef.no/docs/5.4/simapy/) is part of the SIMA
+documentation, with a user guide and examples to download.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

simapy-5.4.0/pyproject.toml

@@ -0,0 +1,54 @@
+[build-system]
+requires = ["setuptools>=70.0.0", "wheel>=0.38.1"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "simapy"
+version = "5.4.0"
+description = "Python utilities for SIMA"
+readme = "README.md"
+authors = [
+    {name = "SINTEF Ocean"}
+]
+requires-python = ">=3.11"
+license = {text = "MIT License"}
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "dmtpy==0.3.6",
+    "numpy",
+    "simapy-results==5.4.0",
+    "tqdm",
+]
+
+[project.optional-dependencies]
+pandas = ["simapy-results[pandas]==5.4.0"]
+hdf5 = ["simapy-results[hdf5]==5.4.0"]
+all = ["simapy[pandas,hdf5]"]
+
+[project.urls]
+Homepage = "https://github.com/SINTEF/simapy"
+
+[dependency-groups]
+dev = [
+    "pylint>=4",
+    "pytest>=8.3.5",
+    "simapy[all]",
+]
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+packages = {find = {where = ["src"], exclude = ["tests", "tests.*"]}}
+
+[tool.uv.workspace]
+members = ["packages/*"]
+
+[tool.uv.sources]
+simapy-results = { workspace = true }
+
+# Each distribution runs its own tests: both test folders are packages named `tests`.
+[tool.pytest.ini_options]
+testpaths = ["src/tests"]

simapy-5.4.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

simapy-5.4.0/src/simapy/metocean/blueprints/metocean.py

@@ -0,0 +1,19 @@
+# Description for scatter data based on Hs-Tp.
+# Generated with MetoceanBlueprint
+from dmt.blueprint import Blueprint
+from dmt.dimension import Dimension
+from dmt.attribute import Attribute
+from dmt.enum_attribute import EnumAttribute
+from dmt.blueprint_attribute import BlueprintAttribute
+from dmt.blueprints.namedentity import NamedEntityBlueprint
+
+class MetoceanBlueprint(NamedEntityBlueprint):
+    """Description for scatter data based on Hs-Tp."""
+
+    def __init__(self, name="Metocean", package_path="metocean", description="Description for scatter data based on Hs-Tp."):
+        super().__init__(name,package_path,description)
+        self.add_attribute(Attribute("description","string","",default=""))
+        self.add_attribute(Attribute("name","string","name for the metocean data."))
+        self.add_attribute(BlueprintAttribute("hindcasts","/hindcast/Hindcast","hindcast data.",True,Dimension("*")))
+        self.add_attribute(BlueprintAttribute("scatters","/scatter/Scatter","scatter data.",True,Dimension("*")))
+        self.add_attribute(BlueprintAttribute("longterms","/longTermStatistics/LongTermStats","scatter data.",True,Dimension("*")))

simapy-5.4.0/src/simapy/metocean/hindcast/blueprints/hindcast.py

@@ -0,0 +1,22 @@
+# Description for hindcast metocean data.
+# Generated with HindcastBlueprint
+from dmt.blueprint import Blueprint
+from dmt.dimension import Dimension
+from dmt.attribute import Attribute
+from dmt.enum_attribute import EnumAttribute
+from dmt.blueprint_attribute import BlueprintAttribute
+from dmt.blueprints.namedentity import NamedEntityBlueprint
+
+class HindcastBlueprint(NamedEntityBlueprint):
+    """Description for hindcast metocean data."""
+
+    def __init__(self, name="Hindcast", package_path="metocean/hindcast", description="Description for hindcast metocean data."):
+        super().__init__(name,package_path,description)
+        self.add_attribute(Attribute("description","string","",default=""))
+        self.add_attribute(Attribute("name","string","name for the metocean data."))
+        self.add_attribute(Attribute("date","string","date string.",Dimension("*")))
+        self.add_attribute(Attribute("latitude","number","",default=0.0))
+        self.add_attribute(Attribute("longitude","number","",default=0.0))
+        self.add_attribute(BlueprintAttribute("wave","/hindcast/StochasticWave","wave models.",True,Dimension("*")))
+        self.add_attribute(BlueprintAttribute("wind","/hindcast/StochasticWind","wind models.",True,Dimension("*")))
+        self.add_attribute(BlueprintAttribute("current","/hindcast/StochasticCurrent","current models.",True,Dimension("*")))

simapy-5.4.0/src/simapy/metocean/hindcast/hindcast.py

@@ -0,0 +1,144 @@
+# This an autogenerated file
+# Description for hindcast metocean data.
+# Generated with Hindcast
+from typing import Dict,Sequence,List
+from dmt.blueprint import Blueprint
+from .blueprints.hindcast import HindcastBlueprint
+from numpy import ndarray,asarray
+from .stochasticcurrent import StochasticCurrent
+from .stochasticwave import StochasticWave
+from .stochasticwind import StochasticWind
+from dmt.namedentity import NamedEntity
+
+class Hindcast(NamedEntity):
+    """
+    Description for hindcast metocean data.
+    Keyword arguments
+    -----------------
+    description : str
+         (default "")
+    name : str
+         name for the metocean data.(default None)
+    date : ndarray of str
+         date string.
+    latitude : float
+         (default 0.0)
+    longitude : float
+         (default 0.0)
+    wave : List[StochasticWave]
+         wave models.
+    wind : List[StochasticWind]
+         wind models.
+    current : List[StochasticCurrent]
+         current models.
+    """
+
+    def __init__(self , description="", latitude=0.0, longitude=0.0, **kwargs):
+        super().__init__(**kwargs)
+        self.description = description
+        self.name = None
+        self.date = []
+        self.latitude = latitude
+        self.longitude = longitude
+        self.wave = list()
+        self.wind = list()
+        self.current = list()
+        for key, value in kwargs.items():
+            if not isinstance(value, Dict):
+                setattr(self, key, value)
+
+
+    @property
+    def blueprint(self) -> Blueprint:
+        """Return blueprint that this entity represents"""
+        return HindcastBlueprint()
+
+
+    @property
+    def description(self) -> str:
+        """"""
+        return self.__description
+
+    @description.setter
+    def description(self, value: str):
+        """Set description"""
+        self.__description = value
+
+    @property
+    def name(self) -> str:
+        """name for the metocean data."""
+        return self.__name
+
+    @name.setter
+    def name(self, value: str):
+        """Set name"""
+        self.__name = value
+
+    @property
+    def date(self) -> ndarray:
+        """date string."""
+        return self.__date
+
+    @date.setter
+    def date(self, value: ndarray):
+        """Set date"""
+        array = asarray(value, dtype=str)
+        if len(array) > 0 and array.ndim != 1:
+            raise ValueError("Expected array with 1 dimensions")
+        self.__date = array
+
+    @property
+    def latitude(self) -> float:
+        """"""
+        return self.__latitude
+
+    @latitude.setter
+    def latitude(self, value: float):
+        """Set latitude"""
+        self.__latitude = float(value)
+
+    @property
+    def longitude(self) -> float:
+        """"""
+        return self.__longitude
+
+    @longitude.setter
+    def longitude(self, value: float):
+        """Set longitude"""
+        self.__longitude = float(value)
+
+    @property
+    def wave(self) -> List[StochasticWave]:
+        """wave models."""
+        return self.__wave
+
+    @wave.setter
+    def wave(self, value: List[StochasticWave]):
+        """Set wave"""
+        if not isinstance(value, Sequence):
+            raise ValueError("Expected sequense, but was " , type(value))
+        self.__wave = value
+
+    @property
+    def wind(self) -> List[StochasticWind]:
+        """wind models."""
+        return self.__wind
+
+    @wind.setter
+    def wind(self, value: List[StochasticWind]):
+        """Set wind"""
+        if not isinstance(value, Sequence):
+            raise ValueError("Expected sequense, but was " , type(value))
+        self.__wind = value
+
+    @property
+    def current(self) -> List[StochasticCurrent]:
+        """current models."""
+        return self.__current
+
+    @current.setter
+    def current(self, value: List[StochasticCurrent]):
+        """Set current"""
+        if not isinstance(value, Sequence):
+            raise ValueError("Expected sequense, but was " , type(value))
+        self.__current = value

simapy-5.4.0/src/simapy/metocean/hindcast/stochasticcurrent.py

@@ -0,0 +1,99 @@
+# This an autogenerated file
+# Description for stochastic current.
+# Generated with StochasticCurrent
+from typing import Dict,Sequence,List
+from dmt.blueprint import Blueprint
+from .blueprints.stochasticcurrent import StochasticCurrentBlueprint
+from numpy import ndarray,asarray
+from dmt.namedentity import NamedEntity
+
+class StochasticCurrent(NamedEntity):
+    """
+    Description for stochastic current.
+    Keyword arguments
+    -----------------
+    description : str
+         (default "")
+    name : str
+         name for the metocean data.(default None)
+    speed : ndarray of float
+         mean current speed.
+    direction : ndarray of float
+         current direction.
+    level : float
+         at this level, upward positive.(default 0.0)
+    """
+
+    def __init__(self , description="", level=0.0, **kwargs):
+        super().__init__(**kwargs)
+        self.description = description
+        self.name = None
+        self.speed = []
+        self.direction = []
+        self.level = level
+        for key, value in kwargs.items():
+            if not isinstance(value, Dict):
+                setattr(self, key, value)
+
+
+    @property
+    def blueprint(self) -> Blueprint:
+        """Return blueprint that this entity represents"""
+        return StochasticCurrentBlueprint()
+
+
+    @property
+    def description(self) -> str:
+        """"""
+        return self.__description
+
+    @description.setter
+    def description(self, value: str):
+        """Set description"""
+        self.__description = value
+
+    @property
+    def name(self) -> str:
+        """name for the metocean data."""
+        return self.__name
+
+    @name.setter
+    def name(self, value: str):
+        """Set name"""
+        self.__name = value
+
+    @property
+    def speed(self) -> ndarray:
+        """mean current speed."""
+        return self.__speed
+
+    @speed.setter
+    def speed(self, value: ndarray):
+        """Set speed"""
+        array = asarray(value, dtype=float)
+        if len(array) > 0 and array.ndim != 1:
+            raise ValueError("Expected array with 1 dimensions")
+        self.__speed = array
+
+    @property
+    def direction(self) -> ndarray:
+        """current direction."""
+        return self.__direction
+
+    @direction.setter
+    def direction(self, value: ndarray):
+        """Set direction"""
+        array = asarray(value, dtype=float)
+        if len(array) > 0 and array.ndim != 1:
+            raise ValueError("Expected array with 1 dimensions")
+        self.__direction = array
+
+    @property
+    def level(self) -> float:
+        """at this level, upward positive."""
+        return self.__level
+
+    @level.setter
+    def level(self, value: float):
+        """Set level"""
+        self.__level = float(value)

simapy-5.4.0/src/simapy/metocean/hindcast/stochasticwave.py

@@ -0,0 +1,128 @@
+# This an autogenerated file
+# Description for stochastic wave.
+# Generated with StochasticWave
+from typing import Dict,Sequence,List
+from dmt.blueprint import Blueprint
+from .blueprints.stochasticwave import StochasticWaveBlueprint
+from numpy import ndarray,asarray
+from dmt.namedentity import NamedEntity
+
+class StochasticWave(NamedEntity):
+    """
+    Description for stochastic wave.
+    Keyword arguments
+    -----------------
+    description : str
+         (default "")
+    name : str
+         name for the metocean data.(default None)
+    hs : ndarray of float
+         significant wave height.
+    tp : ndarray of float
+         peack period.
+    tm : float
+         mean period.(default 0.0)
+    direction : ndarray of float
+         dominant wave direction.
+    meanDirection : float
+         mean wave direction.(default 0.0)
+    """
+
+    def __init__(self , description="", tm=0.0, meanDirection=0.0, **kwargs):
+        super().__init__(**kwargs)
+        self.description = description
+        self.name = None
+        self.hs = []
+        self.tp = []
+        self.tm = tm
+        self.direction = []
+        self.meanDirection = meanDirection
+        for key, value in kwargs.items():
+            if not isinstance(value, Dict):
+                setattr(self, key, value)
+
+
+    @property
+    def blueprint(self) -> Blueprint:
+        """Return blueprint that this entity represents"""
+        return StochasticWaveBlueprint()
+
+
+    @property
+    def description(self) -> str:
+        """"""
+        return self.__description
+
+    @description.setter
+    def description(self, value: str):
+        """Set description"""
+        self.__description = value
+
+    @property
+    def name(self) -> str:
+        """name for the metocean data."""
+        return self.__name
+
+    @name.setter
+    def name(self, value: str):
+        """Set name"""
+        self.__name = value
+
+    @property
+    def hs(self) -> ndarray:
+        """significant wave height."""
+        return self.__hs
+
+    @hs.setter
+    def hs(self, value: ndarray):
+        """Set hs"""
+        array = asarray(value, dtype=float)
+        if len(array) > 0 and array.ndim != 1:
+            raise ValueError("Expected array with 1 dimensions")
+        self.__hs = array
+
+    @property
+    def tp(self) -> ndarray:
+        """peack period."""
+        return self.__tp
+
+    @tp.setter
+    def tp(self, value: ndarray):
+        """Set tp"""
+        array = asarray(value, dtype=float)
+        if len(array) > 0 and array.ndim != 1:
+            raise ValueError("Expected array with 1 dimensions")
+        self.__tp = array
+
+    @property
+    def tm(self) -> float:
+        """mean period."""
+        return self.__tm
+
+    @tm.setter
+    def tm(self, value: float):
+        """Set tm"""
+        self.__tm = float(value)
+
+    @property
+    def direction(self) -> ndarray:
+        """dominant wave direction."""
+        return self.__direction
+
+    @direction.setter
+    def direction(self, value: ndarray):
+        """Set direction"""
+        array = asarray(value, dtype=float)
+        if len(array) > 0 and array.ndim != 1:
+            raise ValueError("Expected array with 1 dimensions")
+        self.__direction = array
+
+    @property
+    def meanDirection(self) -> float:
+        """mean wave direction."""
+        return self.__meanDirection
+
+    @meanDirection.setter
+    def meanDirection(self, value: float):
+        """Set meanDirection"""
+        self.__meanDirection = float(value)

simapy-5.4.0/src/simapy/metocean/hindcast/stochasticwind.py

@@ -0,0 +1,99 @@
+# This an autogenerated file
+# Description for stochastic wind.
+# Generated with StochasticWind
+from typing import Dict,Sequence,List
+from dmt.blueprint import Blueprint
+from .blueprints.stochasticwind import StochasticWindBlueprint
+from numpy import ndarray,asarray
+from dmt.namedentity import NamedEntity
+
+class StochasticWind(NamedEntity):
+    """
+    Description for stochastic wind.
+    Keyword arguments
+    -----------------
+    description : str
+         (default "")
+    name : str
+         name for the metocean data.(default None)
+    speed : ndarray of float
+         mean wind speed.
+    direction : ndarray of float
+         wind direction.
+    level : float
+         at this level, upward positive.(default 0.0)
+    """
+
+    def __init__(self , description="", level=0.0, **kwargs):
+        super().__init__(**kwargs)
+        self.description = description
+        self.name = None
+        self.speed = []
+        self.direction = []
+        self.level = level
+        for key, value in kwargs.items():
+            if not isinstance(value, Dict):
+                setattr(self, key, value)
+
+
+    @property
+    def blueprint(self) -> Blueprint:
+        """Return blueprint that this entity represents"""
+        return StochasticWindBlueprint()
+
+
+    @property
+    def description(self) -> str:
+        """"""
+        return self.__description
+
+    @description.setter
+    def description(self, value: str):
+        """Set description"""
+        self.__description = value
+
+    @property
+    def name(self) -> str:
+        """name for the metocean data."""
+        return self.__name
+
+    @name.setter
+    def name(self, value: str):
+        """Set name"""
+        self.__name = value
+
+    @property
+    def speed(self) -> ndarray:
+        """mean wind speed."""
+        return self.__speed
+
+    @speed.setter
+    def speed(self, value: ndarray):
+        """Set speed"""
+        array = asarray(value, dtype=float)
+        if len(array) > 0 and array.ndim != 1:
+            raise ValueError("Expected array with 1 dimensions")
+        self.__speed = array
+
+    @property
+    def direction(self) -> ndarray:
+        """wind direction."""
+        return self.__direction
+
+    @direction.setter
+    def direction(self, value: ndarray):
+        """Set direction"""
+        array = asarray(value, dtype=float)
+        if len(array) > 0 and array.ndim != 1:
+            raise ValueError("Expected array with 1 dimensions")
+        self.__direction = array
+
+    @property
+    def level(self) -> float:
+        """at this level, upward positive."""
+        return self.__level
+
+    @level.setter
+    def level(self, value: float):
+        """Set level"""
+        self.__level = float(value)

simapy-5.4.0/src/simapy/metocean/longTermStatistics/blueprints/hsbinned.py

@@ -0,0 +1,19 @@
+# Statistical representation of a a sector.
+# Generated with HsBinnedBlueprint
+from dmt.blueprint import Blueprint
+from dmt.dimension import Dimension
+from dmt.attribute import Attribute
+from dmt.enum_attribute import EnumAttribute
+from dmt.blueprint_attribute import BlueprintAttribute
+from dmt.blueprints.namedentity import NamedEntityBlueprint
+
+class HsBinnedBlueprint(NamedEntityBlueprint):
+    """Statistical representation of a a sector."""
+
+    def __init__(self, name="HsBinned", package_path="metocean/longTermStatistics", description="Statistical representation of a a sector."):
+        super().__init__(name,package_path,description)
+        self.add_attribute(Attribute("description","string","",default=""))
+        self.add_attribute(Attribute("name","string","unique name for this bin."))
+        self.add_attribute(Attribute("upperHsLimit","number","mean sector direction.",default=0.0))
+        self.add_attribute(Attribute("lowerHsLimit","number","mean sector direction.",default=0.0))
+        self.add_attribute(BlueprintAttribute("weibullDistribution","/longTermStatistics/Weibull","Weibull parameters.",True))

simapy-5.4.0/src/simapy/metocean/longTermStatistics/blueprints/hsbinnedsector.py

@@ -0,0 +1,20 @@
+# Statistical representation of a a sector.
+# Generated with HsBinnedSectorBlueprint
+from dmt.blueprint import Blueprint
+from dmt.dimension import Dimension
+from dmt.attribute import Attribute
+from dmt.enum_attribute import EnumAttribute
+from dmt.blueprint_attribute import BlueprintAttribute
+from dmt.blueprints.namedentity import NamedEntityBlueprint
+
+class HsBinnedSectorBlueprint(NamedEntityBlueprint):
+    """Statistical representation of a a sector."""
+
+    def __init__(self, name="HsBinnedSector", package_path="metocean/longTermStatistics", description="Statistical representation of a a sector."):
+        super().__init__(name,package_path,description)
+        self.add_attribute(Attribute("description","string","",default=""))
+        self.add_attribute(Attribute("name","string","unique name for the sector, e.g. sec120, or omni."))
+        self.add_attribute(Attribute("direction","number","mean sector direction.",default=0.0))
+        self.add_attribute(Attribute("sectorSize","number","sector size.",default=0.0))
+        self.add_attribute(Attribute("probability","number","probability of this combination",default=0.0))
+        self.add_attribute(BlueprintAttribute("bins","/longTermStatistics/HsBinned","different Hs bins.",True,Dimension("*")))