pythonfmu3 0.1.10__tar.gz → 0.1.12__tar.gz

{pythonfmu3-0.1.10/pythonfmu3.egg-info → pythonfmu3-0.1.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pythonfmu3
-Version: 0.1.10
+Version: 0.1.12
 Summary: A lightweight framework that enables the packaging of Python3.x code as co-simulation FMUs.
 Home-page: https://github.com/stephensmith25/PythonFMU3
 Author: Stephen Smith
@@ -19,8 +19,10 @@ Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Topic :: Scientific/Engineering
 Description-Content-Type: text/markdown
-Provides-Extra: tests
 License-File: LICENSE
+Provides-Extra: tests
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: fmpy; extra == "tests"
 
 # PythonFMU3
 
@@ -38,13 +40,7 @@ This project is a fork of the original PythonFMU repository available at https:/
 
 ### Support:
 
-We currently support a basic FMU which follows the FMI3 standard. This includes support for:
-
-- Float64, Int32, UInt64, String, Boolean variables
-- Step Mode
-- Arrays, which requires the numpy package
-
-Please take a look at the examples bouncingBall.py and linearTransform.py for a demonstration of these features.
+Please take a look at the examples to see the supported features.
 
 ### Future
 
@@ -53,7 +49,6 @@ In no particular order, we plan to add support for:
 - Support more variable types from FMI3
 - Improve array support
 - Add event mode
-- Include FMI3 related testing
 
 ### How do I build an FMU from python code?
 

{pythonfmu3-0.1.10 → pythonfmu3-0.1.12}/README.md

@@ -14,13 +14,7 @@ This project is a fork of the original PythonFMU repository available at https:/
 
 ### Support:
 
-We currently support a basic FMU which follows the FMI3 standard. This includes support for:
-
-- Float64, Int32, UInt64, String, Boolean variables
-- Step Mode
-- Arrays, which requires the numpy package
-
-Please take a look at the examples bouncingBall.py and linearTransform.py for a demonstration of these features.
+Please take a look at the examples to see the supported features.
 
 ### Future
 
@@ -29,7 +23,6 @@ In no particular order, we plan to add support for:
 - Support more variable types from FMI3
 - Improve array support
 - Add event mode
-- Include FMI3 related testing
 
 ### How do I build an FMU from python code?
 

{pythonfmu3-0.1.10 → pythonfmu3-0.1.12}/pythonfmu3/__init__.py

@@ -4,4 +4,5 @@ from .enums import Fmi3Causality, Fmi3Initial, Fmi3Variability
 from .fmi3slave import Fmi3Slave
 from .variables import Boolean, Enumeration, Int32, Int64, UInt64, Float64, String, Dimension
 from .default_experiment import DefaultExperiment
-from .type_definitions import TypeDefinitions, Item, EnumerationType
+from .variable_types import Float64Type, EnumerationType
+from .unit import BaseUnit, Unit

pythonfmu3-0.1.12/pythonfmu3/_version.py

@@ -0,0 +1 @@
+__version__ = "0.1.12"

{pythonfmu3-0.1.10 → pythonfmu3-0.1.12}/pythonfmu3/fmi3slave.py

@@ -11,10 +11,11 @@ from xml.etree.ElementTree import Element, SubElement
 
 from .logmsg import LogMsg
 from .default_experiment import DefaultExperiment
-from .type_definitions import TypeDefinitions
 from ._version import __version__ as VERSION
 from .enums import Fmi3Type, Fmi3Status, Fmi3Causality, Fmi3Initial, Fmi3Variability
 from .variables import Boolean, Enumeration, Int32, Int64, UInt64, Float64, ModelVariable, String
+from .variable_types import VariableType
+from .unit import Unit
 
 ModelOptions = namedtuple("ModelOptions", ["name", "value", "cli"])
 
@@ -54,7 +55,9 @@ class Fmi3Slave(ABC):
         self.modelName: Optional[str] = self.__class__.__name__
         self.description: Optional[str] = None
         self.default_experiment: Optional[DefaultExperiment] = None
-        self.type_definitions: Optional[TypeDefinitions] = None
+
+        self.type_definitions: Dict[str, VariableType] = {}
+        self.units: Dict[str, Unit] = {}
 
     def to_xml(self, model_options: Dict[str, str] = dict()) -> Element:
         """Build the XML representation of the model.
@@ -99,8 +102,15 @@ class Fmi3Slave(ABC):
 
         SubElement(root, "CoSimulation", attrib=options)
 
-        if self.type_definitions is not None:
-            root.append(self.type_definitions.to_xml())
+        if self.units:
+            unit_defs = SubElement(root, "UnitDefinitions")
+            for _, unit in self.units.items():
+                unit_defs.append(unit.to_xml())
+
+        if self.type_definitions:
+            type_defs = SubElement(root, "TypeDefinitions")
+            for _, val in self.type_definitions.items():
+                type_defs.append(val.to_xml())
 
         if len(self.log_categories) > 0:
             categories = SubElement(root, "LogCategories")
@@ -178,7 +188,7 @@ class Fmi3Slave(ABC):
             raise Exception(f"Unsupported type {type(var)}!")
         var.start = refs if len(getattr(var, "dimensions", [])) > 0 else refs[0]
 
-    def register_variable(self, var: ModelVariable, nested: bool = True):
+    def register_variable(self, var: ModelVariable, nested: bool = True, units: str = "", var_type: Any = None):
         """Register a variable as FMU interface.
         
         Args:
@@ -206,10 +216,18 @@ class Fmi3Slave(ABC):
                 var.setter = lambda v: setattr(owner, var.local_name, np.reshape(v, newshape=getattr(owner, var.local_name).shape))
             else:
                 var.setter = lambda v: setattr(owner, var.local_name, v)
+        
+        if var_type:
+            self.type_definitions[var_type.name] = var_type
+            var.declared_type = var_type.name
 
     def setup_experiment(self, start_time: float):
         pass
 
+    def register_units(self, units: List[Unit]):
+        for unit in units:
+            self.units[unit.name] = unit
+
     def enter_initialization_mode(self):
         pass
 

pythonfmu3-0.1.12/pythonfmu3/unit.py

@@ -0,0 +1,62 @@
+from xml.etree.ElementTree import Element
+
+class BaseUnit(object):
+    tag = "BaseUnit"
+    base_units = {
+        "kg": 0,
+        "m": 0,
+        "s": 0,
+        "A": 0,
+        "K": 0,
+        "mol": 0,
+        "cd": 0,
+        "rad": 0,
+    }
+
+    def __init__(self, factor=1.0, offset=0.0, **kwargs) -> None:
+        self._factor = factor
+        self._offset = offset
+        self._units = {**BaseUnit.base_units, **kwargs}
+
+    @property
+    def units(self):
+        return {key: str(value) for key, value in self._units.items() if value != 0}
+
+    def to_xml(self):
+      """Convert the variable to XML node.
+
+      Returns
+          xml.etree.ElementTree.Element: XML node
+      """
+      attrib = dict()
+      if self._factor != 1.0:
+        attrib["factor"] = str(self._factor)
+      if self._offset != 0.0:
+        attrib["offset"] = str(self._offset)
+      attrib.update(self.units)
+      ele = Element(self.tag, attrib)
+      return ele
+
+
+class Unit(object):
+    tag = "Unit"
+
+    def __init__(self, name, **kwargs):
+        self._name = name
+        self._base_unit = BaseUnit(**kwargs)
+
+    @property
+    def name(self) -> str:
+       return self._name
+
+    def to_xml(self) -> Element:
+      """Convert the variable to XML node.
+
+      Returns
+          xml.etree.ElementTree.Element: XML node
+      """
+      attrib = dict()
+      attrib["name"] = self._name
+      ele = Element(self.tag, attrib)
+      ele.append(self._base_unit.to_xml())
+      return ele

pythonfmu3-0.1.10/pythonfmu3/type_definitions.py → pythonfmu3-0.1.12/pythonfmu3/variable_types.py

@@ -1,13 +1,20 @@
 from enum import Enum
-from typing import Any, Optional, List
+from typing import Optional
 from xml.etree.ElementTree import Element
 
+class VariableType(object):
 
-class TypeDefinitions(object):
-    tag = "TypeDefinitions"
-
-    def __init__(self, types: List[Any]):
-        self.types = types
+    def __init__(self, tag, name, **kwargs):
+        self._tag = tag
+        self._attrs = {
+            "name": name,
+        }
+        self._attrs.update(**kwargs)
+    
+    @property
+    def name(self) -> str:
+        """str: Variable name"""
+        return self._attrs["name"]
 
     def to_xml(self) -> Element:
         """Convert the variable to XML node.
@@ -16,19 +23,25 @@ class TypeDefinitions(object):
             xml.etree.ElementTree.Element: XML node
         """
         attrib = dict()
-        ele = Element(self.tag, attrib)
-        for definition in self.types:
-            ele.append(definition.to_xml())
-        return ele
+        for key, value in self._attrs.items():
+            if value is not None:
+                attrib[key] = str(value.name if isinstance(value, Enum) else value)
+        return Element(self._tag, attrib)
+
+class Float64Type(VariableType):
+    tag = "Float64Type"
+
+    def __init__(self, name, **kwargs):
+        super().__init__(self.tag, name, **kwargs)
 
 
 class Item(object):
     tag = "Item"
 
-    def __init__(self, name: str, value: str, description: str = ""):
+    def __init__(self, name: str, value: int, description: str = "", **kwargs):
         self.__attrs = {
             "name": name,
-            "value": value,
+            "value": str(value),
             "description": description
         }
 
@@ -61,18 +74,21 @@ class Item(object):
                f"value={self.value}, " \
                f"description={self.description})"
 
-
-class EnumerationType(object):
+class EnumerationType(VariableType):
     tag = "EnumerationType"
 
-    def __init__(self, name: str, items = List[Item]):
-        self.__attrs = {
-            "name": name
-        }
-        self._items = items
+    def __init__(self, name: str, values: Optional[Enum] = None,  **kwargs):
+        super().__init__(self.tag, name, **kwargs)
+        self._items = {}
+        
+        for val in values:
+            self.add_value(name = val.name, value = val.value)
 
-    def name(self) -> str:
-        return self.__attrs["name"]
+    def add_value(self, name: str, value: int, description: str = "", **kwargs):
+        self._items[name] = Item(name, value, description, **kwargs)
+    
+    def get_value(self, name):
+        return self._items[name]
 
     def to_xml(self) -> Element:
         """Convert the variable to XML node.
@@ -80,7 +96,7 @@ class EnumerationType(object):
         Returns
             xml.etree.ElementTree.Element: XML node
         """
-        element = Element(self.tag, self.__attrs)
-        for item in self._items:
-            element.append(item.to_xml())
-        return element
+        parent = super().to_xml()
+        for _, item in self._items.items():
+            parent.append(item.to_xml())
+        return parent

{pythonfmu3-0.1.10 → pythonfmu3-0.1.12}/pythonfmu3/variables.py

@@ -32,6 +32,7 @@ class ModelVariable(ABC):
         description: Optional[str] = None,
         initial: Optional[Fmi3Initial] = None,
         variability: Optional[Fmi3Variability] = None,
+        declared_type: Optional[str] = None,
         getter: Any = None,
         setter: Any = None
     ):
@@ -46,6 +47,7 @@ class ModelVariable(ABC):
             "causality": causality,
             "variability": variability,
             "initial": initial,
+            "declaredType": declared_type,
             # 'canHandleMultipleSetPerTimeInstant': # Only for ME
         }
         self._extras = {}
@@ -81,6 +83,17 @@ class ModelVariable(ABC):
             raise RuntimeError("Value reference already set.")
         self.__attrs["valueReference"] = value
 
+    @property
+    def declared_type(self) -> str:
+        """str: declared type"""
+        return self.__attrs["declaredType"]
+
+    @declared_type.setter
+    def declared_type(self, value: str):
+        if self.__attrs["declaredType"] is not None:
+            raise RuntimeError("Declared type already set.")
+        self.__attrs["declaredType"] = value
+    
     @property
     def variability(self) -> Optional[Fmi3Variability]:
         """:obj:`Fmi3Variability` or None: Variable variability - None if not set"""
@@ -145,10 +158,11 @@ class Dimension(object):
         return ele
 
 class Float64(ModelVariable):
-    def __init__(self, name: str, start: Optional[Any] = None, derivative: Optional[Any] = None, dimensions: List[Dimension] = [], **kwargs):
+    def __init__(self, name: str, start: Optional[Any] = None, derivative: Optional[Any] = None, dimensions: List[Dimension] = [], unit: Optional[str] = None, **kwargs):
         super().__init__(name, **kwargs)
         self.__attrs = {"start": start, "derivative": derivative}
         self._type = "Float64"
+        self._unit = unit
         if dimensions:
             check_numpy()
         self.__dimensions = dimensions
@@ -160,6 +174,14 @@ class Float64(ModelVariable):
     @start.setter
     def start(self, value: float):
         self.__attrs["start"] = value
+    
+    @property
+    def unit(self) -> Optional[Any]:
+        return self._unit
+
+    @unit.setter
+    def unit(self, value: str):
+        self._unit = value
 
     @property
     def derivative(self):
@@ -169,6 +191,7 @@ class Float64(ModelVariable):
     def dimensions(self) -> List[Dimension]:
         return self.__dimensions
 
+
     def to_xml(self) -> Element:
         attrib = dict()
         for key, value in self.__attrs.items():
@@ -181,6 +204,10 @@ class Float64(ModelVariable):
                 else:
                     output = f"{value:.16g}"
                 attrib[key] = output
+
+        if self.unit:
+            attrib["unit"] = self.unit
+
         self._extras = attrib
         parent = super().to_xml()
 

{pythonfmu3-0.1.10 → pythonfmu3-0.1.12/pythonfmu3.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pythonfmu3
-Version: 0.1.10
+Version: 0.1.12
 Summary: A lightweight framework that enables the packaging of Python3.x code as co-simulation FMUs.
 Home-page: https://github.com/stephensmith25/PythonFMU3
 Author: Stephen Smith
@@ -19,8 +19,10 @@ Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Topic :: Scientific/Engineering
 Description-Content-Type: text/markdown
-Provides-Extra: tests
 License-File: LICENSE
+Provides-Extra: tests
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: fmpy; extra == "tests"
 
 # PythonFMU3
 
@@ -38,13 +40,7 @@ This project is a fork of the original PythonFMU repository available at https:/
 
 ### Support:
 
-We currently support a basic FMU which follows the FMI3 standard. This includes support for:
-
-- Float64, Int32, UInt64, String, Boolean variables
-- Step Mode
-- Arrays, which requires the numpy package
-
-Please take a look at the examples bouncingBall.py and linearTransform.py for a demonstration of these features.
+Please take a look at the examples to see the supported features.
 
 ### Future
 
@@ -53,7 +49,6 @@ In no particular order, we plan to add support for:
 - Support more variable types from FMI3
 - Improve array support
 - Add event mode
-- Include FMI3 related testing
 
 ### How do I build an FMU from python code?
 

{pythonfmu3-0.1.10 → pythonfmu3-0.1.12}/pythonfmu3.egg-info/SOURCES.txt

@@ -13,7 +13,8 @@ pythonfmu3/enums.py
 pythonfmu3/fmi3slave.py
 pythonfmu3/logmsg.py
 pythonfmu3/osutil.py
-pythonfmu3/type_definitions.py
+pythonfmu3/unit.py
+pythonfmu3/variable_types.py
 pythonfmu3/variables.py
 pythonfmu3.egg-info/PKG-INFO
 pythonfmu3.egg-info/SOURCES.txt

pythonfmu3-0.1.10/pythonfmu3/_version.py

@@ -1 +0,0 @@
-__version__ = "0.1.10"