simapy 4.6.1.dev1__tar.gz → 4.8.0__tar.gz

simapy-4.8.0/PKG-INFO

@@ -0,0 +1,45 @@
+Metadata-Version: 2.1
+Name: simapy
+Version: 4.8.0
+Summary: Python utilities for SIMA
+Home-page: https://github.com/SINTEF/simapy
+Author: SINTEF Ocean
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: dmtpy==0.3.4
+Requires-Dist: numpy
+
+SIMAPy - Python utilities for SIMA
+=================================================================
+
+This Python library can be used to interact with [SIMA](https://sima.sintef.no)
+
+Parts of the library is generated from [data models](https://github.com/SINTEF/sima-dmt-models) using a [Python code generator](https://github.com/SINTEF/dmt-gen-py)
+
+Please examine the tests for ways to interact
+
+Also check out the examples in [simapy-examples](https://github.com/SINTEF/simapy-examples)
+
+## Installation
+
+Use the package manager [pip](https://pip.pypa.io/en/stable/) to install simapy.
+
+```bash
+pip install simapy
+```
+
+## Dependencies
+
+* [DMTPY](https://github.com/SINTEF/dmtpy)
+
+## Authors
+
+* **Lasse Bjermeland** - [lassebje](https://github.com/lassebje)
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

simapy-4.8.0/README.md

@@ -0,0 +1,30 @@
+SIMAPy - Python utilities for SIMA
+=================================================================
+
+This Python library can be used to interact with [SIMA](https://sima.sintef.no)
+
+Parts of the library is generated from [data models](https://github.com/SINTEF/sima-dmt-models) using a [Python code generator](https://github.com/SINTEF/dmt-gen-py)
+
+Please examine the tests for ways to interact
+
+Also check out the examples in [simapy-examples](https://github.com/SINTEF/simapy-examples)
+
+## Installation
+
+Use the package manager [pip](https://pip.pypa.io/en/stable/) to install simapy.
+
+```bash
+pip install simapy
+```
+
+## Dependencies
+
+* [DMTPY](https://github.com/SINTEF/dmtpy)
+
+## Authors
+
+* **Lasse Bjermeland** - [lassebje](https://github.com/lassebje)
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

simapy-4.8.0/setup.cfg

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

simapy-4.8.0/setup.py

@@ -0,0 +1,36 @@
+# Always prefer setuptools over distutils
+from pathlib import Path
+import shutil
+from setuptools import setup, find_packages
+
+here = Path(__file__).parent.resolve()
+
+# Get the long description from the README file
+long_description = (here / "README.md").read_text(encoding="utf-8")
+
+
+# Remove build and dist folders
+shutil.rmtree(Path("build"), ignore_errors=True)
+shutil.rmtree(Path("dist"), ignore_errors=True)
+
+with open('requirements.txt',encoding='utf8') as f:
+    required = f.read().splitlines()
+
+setup(
+    name="simapy",
+    version="4.8.0",
+    author="SINTEF Ocean",
+    description="Python utilities for SIMA",
+    url="https://github.com/SINTEF/simapy",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    package_dir={"": "src"},
+    packages=find_packages(where="src", exclude=["tests"]),
+   install_requires=required,
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    python_requires=">=3.8",
+)

simapy-4.8.0/src/simapy/sima/command/blueprints/exportblueprintcommand.py

@@ -0,0 +1,20 @@
+# 
+# Generated with ExportBlueprintCommandBlueprint
+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 .command import CommandBlueprint
+
+class ExportBlueprintCommandBlueprint(CommandBlueprint):
+    """"""
+
+    def __init__(self, name="ExportBlueprintCommand", package_path="sima/command", description=""):
+        super().__init__(name,package_path,description)
+        self.add_attribute(Attribute("description","string","",default=""))
+        self.add_attribute(BlueprintAttribute("scriptableValues","sima/sima/ScriptableValue","",True,Dimension("*")))
+        self.add_attribute(Attribute("name","string",""))
+        self.add_attribute(BlueprintAttribute("parameters","sima/sima/Property","Additional parameters",True,Dimension("*")))
+        self.add_attribute(Attribute("output","string","Optional output directory. If not specified the blueprints will be imported into the current workspace"))
+        self.add_attribute(Attribute("delete","boolean","Delete the content of the output folder before exporting",default=False))

simapy-4.8.0/src/simapy/sima/command/exportblueprintcommand.py

@@ -0,0 +1,110 @@
+# This an autogenerated file
+# 
+# Generated with ExportBlueprintCommand
+from typing import Dict,Sequence,List
+from dmt.blueprint import Blueprint
+from .blueprints.exportblueprintcommand import ExportBlueprintCommandBlueprint
+from typing import Dict
+from ..sima import Property
+from ..sima import ScriptableValue
+from .command import Command
+
+class ExportBlueprintCommand(Command):
+    """
+    Keyword arguments
+    -----------------
+    description : str
+         (default "")
+    scriptableValues : List[ScriptableValue]
+    name : str
+         (default None)
+    parameters : List[Property]
+         Additional parameters
+    output : str
+         Optional output directory. If not specified the blueprints will be imported into the current workspace(default None)
+    delete : bool
+         Delete the content of the output folder before exporting(default False)
+    """
+
+    def __init__(self , description="", delete=False, **kwargs):
+        super().__init__(**kwargs)
+        self.description = description
+        self.scriptableValues = list()
+        self.name = None
+        self.parameters = list()
+        self.output = None
+        self.delete = delete
+        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 ExportBlueprintCommandBlueprint()
+
+
+    @property
+    def description(self) -> str:
+        """"""
+        return self.__description
+
+    @description.setter
+    def description(self, value: str):
+        """Set description"""
+        self.__description = value
+
+    @property
+    def scriptableValues(self) -> List[ScriptableValue]:
+        """"""
+        return self.__scriptableValues
+
+    @scriptableValues.setter
+    def scriptableValues(self, value: List[ScriptableValue]):
+        """Set scriptableValues"""
+        if not isinstance(value, Sequence):
+            raise ValueError("Expected sequense, but was " , type(value))
+        self.__scriptableValues = value
+
+    @property
+    def name(self) -> str:
+        """"""
+        return self.__name
+
+    @name.setter
+    def name(self, value: str):
+        """Set name"""
+        self.__name = value
+
+    @property
+    def parameters(self) -> List[Property]:
+        """Additional parameters"""
+        return self.__parameters
+
+    @parameters.setter
+    def parameters(self, value: List[Property]):
+        """Set parameters"""
+        if not isinstance(value, Sequence):
+            raise ValueError("Expected sequense, but was " , type(value))
+        self.__parameters = value
+
+    @property
+    def output(self) -> str:
+        """Optional output directory. If not specified the blueprints will be imported into the current workspace"""
+        return self.__output
+
+    @output.setter
+    def output(self, value: str):
+        """Set output"""
+        self.__output = value
+
+    @property
+    def delete(self) -> bool:
+        """Delete the content of the output folder before exporting"""
+        return self.__delete
+
+    @delete.setter
+    def delete(self, value: bool):
+        """Set delete"""
+        self.__delete = bool(value)

simapy-4.8.0/src/simapy/sima/environment/__init__.py

@@ -0,0 +1,43 @@
+
+from .apiwind import APIWind # noqa
+from .bretschneiderone import BretschneiderOne # noqa
+from .bretschneidertwo import BretschneiderTwo # noqa
+from .current import Current # noqa
+from .currentitem import CurrentItem # noqa
+from .davenport import DavenPort # noqa
+from .derbyshirescott import DerbyshireScott # noqa
+from .doublemodelspectrum import DoubleModelSpectrum # noqa
+from .environment import Environment # noqa
+from .environmentscontainer import EnvironmentsContainer # noqa
+from .esduwind import ESDUWind # noqa
+from .fluctuatingthreecomponent import FluctuatingThreeComponent # noqa
+from .fluctuatingtwocomponent import FluctuatingTwoComponent # noqa
+from .fluctuatingwindvelocityprofile import FluctuatingWindVelocityProfile # noqa
+from .harris import Harris # noqa
+from .iso199011wind import ISO199011Wind # noqa
+from .jonswap import Jonswap # noqa
+from .jonswap3p import Jonswap3P # noqa
+from .jonswap6p import Jonswap6P # noqa
+from .jonswapdoublepeaked import JonswapDoublePeaked # noqa
+from .numericalwave import NumericalWave # noqa
+from .ochi import Ochi # noqa
+from .piersonmoskowitz import PiersonMoskowitz # noqa
+from .piersonmoskowitzissc import PiersonMoskowitzISSC # noqa
+from .piersonmoskowitzzero import PiersonMoskowitzZero # noqa
+from .regularcurrent import RegularCurrent # noqa
+from .regularwave import RegularWave # noqa
+from .regularwaveitem import RegularWaveItem # noqa
+from .seasurface import SeaSurface # noqa
+from .shearwindvelocityprofile import ShearWindVelocityProfile # noqa
+from .singleenvironment import SingleEnvironment # noqa
+from .sletringen import Sletringen # noqa
+from .stationaryuniform import StationaryUniform # noqa
+from .turbsimfluctuatingthreecomponent import TurbSimFluctuatingThreeComponent # noqa
+from .wave import Wave # noqa
+from .wavefromfile import WaveFromFile # noqa
+from .wills import Wills # noqa
+from .wind import Wind # noqa
+from .windfromfile import WindFromFile # noqa
+from .windvelocityprofile import WindVelocityProfile # noqa
+from .shearprofile import ShearProfile # noqa
+from .wavespreadingtype import WaveSpreadingType # noqa

simapy-4.8.0/src/simapy/sima/environment/blueprints/esduwind.py

@@ -0,0 +1,21 @@
+# 
+# Generated with ESDUWindBlueprint
+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 .wind import WindBlueprint
+
+class ESDUWindBlueprint(WindBlueprint):
+    """"""
+
+    def __init__(self, name="ESDUWind", package_path="sima/environment", description=""):
+        super().__init__(name,package_path,description)
+        self.add_attribute(Attribute("description","string","",default=""))
+        self.add_attribute(BlueprintAttribute("scriptableValues","sima/sima/ScriptableValue","",True,Dimension("*")))
+        self.add_attribute(Attribute("direction","number","Wind propagation direction",default=0.0))
+        self.add_attribute(Attribute("averageVelocity","number","Average velocity at reference height",default=0.0))
+        self.add_attribute(Attribute("profileExponent","number","Wind profile exponent",default=0.11))
+        self.add_attribute(Attribute("friction","number","Surface drag coefficient.\nAlso used for transverse gust spectrum, if specified.",default=0.002))
+        self.add_attribute(Attribute("psi","number","Site latitude in decimal degrees",default=0.0))

simapy-4.8.0/src/simapy/sima/environment/blueprints/iso199011wind.py

@@ -0,0 +1,21 @@
+# 
+# Generated with ISO199011WindBlueprint
+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 .wind import WindBlueprint
+
+class ISO199011WindBlueprint(WindBlueprint):
+    """"""
+
+    def __init__(self, name="ISO199011Wind", package_path="sima/environment", description=""):
+        super().__init__(name,package_path,description)
+        self.add_attribute(Attribute("description","string","",default=""))
+        self.add_attribute(BlueprintAttribute("scriptableValues","sima/sima/ScriptableValue","",True,Dimension("*")))
+        self.add_attribute(Attribute("direction","number","Wind propagation direction",default=0.0))
+        self.add_attribute(Attribute("averageVelocity","number","Average velocity at reference height",default=0.0))
+        self.add_attribute(Attribute("profileExponent","number","Wind profile exponent",default=0.11))
+        self.add_attribute(Attribute("friction","number","Surface drag coefficient.\nAlso used for transverse gust spectrum, if specified.",default=0.002))
+        self.add_attribute(Attribute("referenceHeight","number","Reference height for wind velocity, fixed = 10 m.",default=10.0))

simapy-4.8.0/src/simapy/sima/environment/blueprints/numericalwave.py

@@ -0,0 +1,21 @@
+# 
+# Generated with NumericalWaveBlueprint
+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 .wave import WaveBlueprint
+
+class NumericalWaveBlueprint(WaveBlueprint):
+    """"""
+
+    def __init__(self, name="NumericalWave", package_path="sima/environment", description=""):
+        super().__init__(name,package_path,description)
+        self.add_attribute(Attribute("description","string","",default=""))
+        self.add_attribute(BlueprintAttribute("scriptableValues","sima/sima/ScriptableValue","",True,Dimension("*")))
+        self.add_attribute(Attribute("fromFile","boolean","Define numerical spectrum in external file",default=False))
+        self.add_attribute(Attribute("directions","number","Number of wave directions",Dimension("*"),default=0.0))
+        self.add_attribute(Attribute("frequencies","number","Number of wave frequencies",Dimension("*"),default=0.0))
+        self.add_attribute(Attribute("values","number","",Dimension("*"),default=0.0))
+        self.add_attribute(Attribute("file","string","Name of external file with specified numerical spectrum data"))

simapy-4.8.0/src/simapy/sima/environment/esduwind.py

@@ -0,0 +1,121 @@
+# This an autogenerated file
+# 
+# Generated with ESDUWind
+from typing import Dict,Sequence,List
+from dmt.blueprint import Blueprint
+from .blueprints.esduwind import ESDUWindBlueprint
+from typing import Dict
+from ..sima import ScriptableValue
+from .wind import Wind
+
+class ESDUWind(Wind):
+    """
+    Keyword arguments
+    -----------------
+    description : str
+         (default "")
+    scriptableValues : List[ScriptableValue]
+    direction : float
+         Wind propagation direction(default 0.0)
+    averageVelocity : float
+         Average velocity at reference height(default 0.0)
+    profileExponent : float
+         Wind profile exponent(default 0.11)
+    friction : float
+         Surface drag coefficient.\nAlso used for transverse gust spectrum, if specified.(default 0.002)
+    psi : float
+         Site latitude in decimal degrees(default 0.0)
+    """
+
+    def __init__(self , description="", direction=0.0, averageVelocity=0.0, profileExponent=0.11, friction=0.002, psi=0.0, **kwargs):
+        super().__init__(**kwargs)
+        self.description = description
+        self.scriptableValues = list()
+        self.direction = direction
+        self.averageVelocity = averageVelocity
+        self.profileExponent = profileExponent
+        self.friction = friction
+        self.psi = psi
+        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 ESDUWindBlueprint()
+
+
+    @property
+    def description(self) -> str:
+        """"""
+        return self.__description
+
+    @description.setter
+    def description(self, value: str):
+        """Set description"""
+        self.__description = value
+
+    @property
+    def scriptableValues(self) -> List[ScriptableValue]:
+        """"""
+        return self.__scriptableValues
+
+    @scriptableValues.setter
+    def scriptableValues(self, value: List[ScriptableValue]):
+        """Set scriptableValues"""
+        if not isinstance(value, Sequence):
+            raise ValueError("Expected sequense, but was " , type(value))
+        self.__scriptableValues = value
+
+    @property
+    def direction(self) -> float:
+        """Wind propagation direction"""
+        return self.__direction
+
+    @direction.setter
+    def direction(self, value: float):
+        """Set direction"""
+        self.__direction = float(value)
+
+    @property
+    def averageVelocity(self) -> float:
+        """Average velocity at reference height"""
+        return self.__averageVelocity
+
+    @averageVelocity.setter
+    def averageVelocity(self, value: float):
+        """Set averageVelocity"""
+        self.__averageVelocity = float(value)
+
+    @property
+    def profileExponent(self) -> float:
+        """Wind profile exponent"""
+        return self.__profileExponent
+
+    @profileExponent.setter
+    def profileExponent(self, value: float):
+        """Set profileExponent"""
+        self.__profileExponent = float(value)
+
+    @property
+    def friction(self) -> float:
+        """Surface drag coefficient.
+Also used for transverse gust spectrum, if specified."""
+        return self.__friction
+
+    @friction.setter
+    def friction(self, value: float):
+        """Set friction"""
+        self.__friction = float(value)
+
+    @property
+    def psi(self) -> float:
+        """Site latitude in decimal degrees"""
+        return self.__psi
+
+    @psi.setter
+    def psi(self, value: float):
+        """Set psi"""
+        self.__psi = float(value)

simapy-4.8.0/src/simapy/sima/environment/iso199011wind.py

@@ -0,0 +1,121 @@
+# This an autogenerated file
+# 
+# Generated with ISO199011Wind
+from typing import Dict,Sequence,List
+from dmt.blueprint import Blueprint
+from .blueprints.iso199011wind import ISO199011WindBlueprint
+from typing import Dict
+from ..sima import ScriptableValue
+from .wind import Wind
+
+class ISO199011Wind(Wind):
+    """
+    Keyword arguments
+    -----------------
+    description : str
+         (default "")
+    scriptableValues : List[ScriptableValue]
+    direction : float
+         Wind propagation direction(default 0.0)
+    averageVelocity : float
+         Average velocity at reference height(default 0.0)
+    profileExponent : float
+         Wind profile exponent(default 0.11)
+    friction : float
+         Surface drag coefficient.\nAlso used for transverse gust spectrum, if specified.(default 0.002)
+    referenceHeight : float
+         Reference height for wind velocity, fixed = 10 m.(default 10.0)
+    """
+
+    def __init__(self , description="", direction=0.0, averageVelocity=0.0, profileExponent=0.11, friction=0.002, referenceHeight=10.0, **kwargs):
+        super().__init__(**kwargs)
+        self.description = description
+        self.scriptableValues = list()
+        self.direction = direction
+        self.averageVelocity = averageVelocity
+        self.profileExponent = profileExponent
+        self.friction = friction
+        self.referenceHeight = referenceHeight
+        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 ISO199011WindBlueprint()
+
+
+    @property
+    def description(self) -> str:
+        """"""
+        return self.__description
+
+    @description.setter
+    def description(self, value: str):
+        """Set description"""
+        self.__description = value
+
+    @property
+    def scriptableValues(self) -> List[ScriptableValue]:
+        """"""
+        return self.__scriptableValues
+
+    @scriptableValues.setter
+    def scriptableValues(self, value: List[ScriptableValue]):
+        """Set scriptableValues"""
+        if not isinstance(value, Sequence):
+            raise ValueError("Expected sequense, but was " , type(value))
+        self.__scriptableValues = value
+
+    @property
+    def direction(self) -> float:
+        """Wind propagation direction"""
+        return self.__direction
+
+    @direction.setter
+    def direction(self, value: float):
+        """Set direction"""
+        self.__direction = float(value)
+
+    @property
+    def averageVelocity(self) -> float:
+        """Average velocity at reference height"""
+        return self.__averageVelocity
+
+    @averageVelocity.setter
+    def averageVelocity(self, value: float):
+        """Set averageVelocity"""
+        self.__averageVelocity = float(value)
+
+    @property
+    def profileExponent(self) -> float:
+        """Wind profile exponent"""
+        return self.__profileExponent
+
+    @profileExponent.setter
+    def profileExponent(self, value: float):
+        """Set profileExponent"""
+        self.__profileExponent = float(value)
+
+    @property
+    def friction(self) -> float:
+        """Surface drag coefficient.
+Also used for transverse gust spectrum, if specified."""
+        return self.__friction
+
+    @friction.setter
+    def friction(self, value: float):
+        """Set friction"""
+        self.__friction = float(value)
+
+    @property
+    def referenceHeight(self) -> float:
+        """Reference height for wind velocity, fixed = 10 m."""
+        return self.__referenceHeight
+
+    @referenceHeight.setter
+    def referenceHeight(self, value: float):
+        """Set referenceHeight"""
+        self.__referenceHeight = float(value)