pythonfmu3 0.1.15__py3-none-any.whl → 0.1.17__py3-none-any.whl

pythonfmu3/__init__.py

@@ -1,7 +1,7 @@
 from ._version import __version__
 from .builder import FmuBuilder
-from .enums import Fmi3Causality, Fmi3Initial, Fmi3Variability
-from .fmi3slave import Fmi3Slave
+from .enums import Fmi3Causality, Fmi3Initial, Fmi3Status, Fmi3Variability
+from .fmi3slave import Fmi3Slave, Fmi3StepResult
 from .variables import Boolean, Enumeration, Int32, Int64, UInt64, Float64, String, Dimension
 from .default_experiment import DefaultExperiment
 from .variable_types import Float64Type, EnumerationType

pythonfmu3/_version.py

@@ -1 +1 @@
-__version__ = "0.1.15"
+__version__ = "0.1.17"

pythonfmu3/builder.py

@@ -66,6 +66,7 @@ class FmuBuilder:
         dest: FilePath = ".",
         project_files: Iterable[FilePath] = set(),
         documentation_folder: Optional[FilePath] = None,
+        terminals_folder: Optional[FilePath] = None,
         **options,
     ) -> Path:
         script_file = Path(script_file)
@@ -85,6 +86,13 @@ class FmuBuilder:
                 raise ValueError(
                     f"The documentation folder does not exists {documentation_folder!s}"
                 )
+        
+        if terminals_folder is not None:
+            terminals_folder = Path(terminals_folder)
+            if not terminals_folder.exists():
+                raise ValueError(
+                    f"The terminals folder does not exists {terminals_folder!s}"
+                )
 
         module_name = script_file.stem
 
@@ -178,6 +186,14 @@ class FmuBuilder:
                             relative_f = f.relative_to(documentation_folder)
                             zip_fmu.write(f, arcname=(documentation / relative_f))
 
+                if terminals_folder is not None:
+                    terminals = Path("terminalsAndIcons")
+                    for f in terminals_folder.rglob("*.xml"):
+                        if f.is_file():
+                            relative_f = f.relative_to(terminals_folder)
+                            zip_fmu.write(f, arcname=(terminals / relative_f))
+                    
+
                 # Add the model description
                 xml_str = parseString(tostring(xml, "UTF-8"))
                 zip_fmu.writestr(
@@ -215,6 +231,13 @@ def create_command_parser(parser: argparse.ArgumentParser):
         default=None
     )
 
+    parser.add_argument(
+        "--terminals",
+        dest="terminals_folder",
+        help="Folder containing terminals to include in the FMU.",
+        default=None
+    )
+
     for option in FMI3_MODEL_OPTIONS:
         action = "store_false" if option.value else "store_true"
         parser.add_argument(

pythonfmu3/fmi3slave.py

@@ -5,7 +5,7 @@ import datetime
 from abc import ABC, abstractmethod
 from collections import OrderedDict, namedtuple
 from pathlib import Path
-from typing import Any, ClassVar, Dict, List, Optional
+from typing import Any, ClassVar, Dict, List, NamedTuple, Optional
 from uuid import uuid1
 from xml.etree.ElementTree import Element, SubElement
 
@@ -27,6 +27,11 @@ FMI3_MODEL_OPTIONS: List[ModelOptions] = [
     ModelOptions("canSerializeFMUState", False, "serialize-state")
 ]
 
+class Fmi3StepResult(NamedTuple):
+    status: Fmi3Status = Fmi3Status.ok
+    eventHandlingNeeded: bool = False
+    terminateSimulation: bool = False
+    earlyReturn: bool = False
 
 class Fmi3Slave(ABC):
     """Abstract facade class to execute Python through FMI standard."""
@@ -235,7 +240,7 @@ class Fmi3Slave(ABC):
         pass
 
     @abstractmethod
-    def do_step(self, current_time: float, step_size: float) -> bool:
+    def do_step(self, current_time: float, step_size: float) -> Fmi3StepResult:
         pass
 
     def terminate(self):

pythonfmu3/osutil.py

@@ -1,5 +1,4 @@
 import sys
-import platform
 
 import platform
 
@@ -8,7 +7,8 @@ def get_fmu_arch():
     system = platform.system()
     is_x86 = platform.machine() in ["i386", "AMD64", "x86_64"]
     platforms = {"Windows": "windows", "Linux": "linux", "Darwin": "darwin"}
-    return "x86_64" if is_x86 else "x86" + "-" + platforms.get(system, "unknown")
+    arch = "x86_64" if is_x86 else "x86"
+    return arch + "-" + platforms.get(system, "unknown")
 
 def get_platform() -> str:
     """Get FMU binary platform folder name."""

pythonfmu3/pythonfmu-export/src/cppfmu/cppfmu_common.hpp

@@ -105,11 +105,9 @@ public:
 
     Logger(
         FMIComponentEnvironment component,
-        String instanceName,
         fmi3LogMessageCallback logCallback,
         std::shared_ptr<Settings> settings)
         : m_component{component}
-        , m_instanceName(std::move(instanceName))
         , m_fmiLogger{logCallback}
         , m_settings{settings}
     {
@@ -154,7 +152,6 @@ public:
 
 private:
     const FMIComponentEnvironment m_component;
-    const String m_instanceName;
     const FMICallbackLogger m_fmiLogger;
     std::shared_ptr<Settings> m_settings;
 };

pythonfmu3/pythonfmu-export/src/cppfmu/cppfmu_cs.hpp

@@ -124,10 +124,13 @@ public:
         FMIString value[]) const;
 
     // Called from fmi3DoStep()/fmiDoStep(). Must be implemented in model code.
-    virtual bool DoStep(
+    virtual FMIStatus DoStep(
         FMIFloat64 currentCommunicationPoint,
         FMIFloat64 communicationStepSize,
         FMIBoolean newStep,
+        FMIBoolean* eventHandlingNeeded,
+        FMIBoolean* terminateSimulation,
+        FMIBoolean* earlyReturn,
         FMIFloat64& endOfStep) = 0;
 
     virtual void GetFMUstate(fmi3FMUState& state) = 0;

pythonfmu3/pythonfmu-export/src/cppfmu/fmi_functions.cpp

@@ -47,10 +47,10 @@ struct Component
         modelError = 1 << 12,
         modelFatal = 1 << 13,
     };
-    Component(cppfmu::FMIString instanceName,
+    Component(cppfmu::FMIComponentEnvironment instanceEnvironment,
         cppfmu::FMICallbackLogger logCallback,
         cppfmu::FMIBoolean loggingOn) : loggerSettings{std::make_shared<cppfmu::Logger::Settings>()},
-        logger{this, instanceName, logCallback, loggerSettings}, lastSuccessfulTime{std::numeric_limits<cppfmu::FMIFloat64>::quiet_NaN()}
+        logger{instanceEnvironment, logCallback, loggerSettings}
     {
         loggerSettings->debugLoggingEnabled = (loggingOn == cppfmu::FMITrue);
     }
@@ -62,7 +62,6 @@ struct Component
 
     // Co-simulation
     std::unique_ptr<cppfmu::SlaveInstance> slave;
-    cppfmu::FMIFloat64 lastSuccessfulTime;
 };
 } // namespace
 
@@ -96,7 +95,8 @@ fmi3Instance fmi3InstantiateCoSimulation(
     fmi3IntermediateUpdateCallback intermediateUpdate )
 {
     try {
-        auto component = new Component(instanceName,
+        auto component = new Component(
+            environment,
             logMessage,
             loggingOn);
         component->slave = CppfmuInstantiateSlave(
@@ -658,27 +658,30 @@ fmi3Status fmi3DoStep(
     fmi3Instance c,
     fmi3Float64 currentCommunicationPoint,
     fmi3Float64 communicationStepSize,
-    fmi3Boolean /*noSetFMUStatePriorToCurrentPoint*/,
-    fmi3Boolean*,
-    fmi3Boolean*,
-    fmi3Boolean*,
-    fmi3Float64*)
+    fmi3Boolean noSetFmuStatePriorToCurrentPoint,
+    fmi3Boolean* eventHandlingNeeded ,
+    fmi3Boolean* terminateSimulation,
+    fmi3Boolean* earlyReturn,
+    fmi3Float64* lastSuccessfulTime)
 {
     const auto component = reinterpret_cast<Component*>(c);
     try {
         double endTime = currentCommunicationPoint;
-        const auto ok = component->slave->DoStep(
+        const auto status = component->slave->DoStep(
             currentCommunicationPoint,
             communicationStepSize,
-            fmi3True,
+            noSetFmuStatePriorToCurrentPoint,
+            eventHandlingNeeded,
+            terminateSimulation,
+            earlyReturn,
             endTime);
-        if (ok) {
-            component->lastSuccessfulTime =
+        if (status == fmi3Status::fmi3OK) {
+            *lastSuccessfulTime =
                 currentCommunicationPoint + communicationStepSize;
             return fmi3OK;
         } else {
-            component->lastSuccessfulTime = endTime;
-            return fmi3Discard;
+            *lastSuccessfulTime = endTime;
+            return status;
         }
     } catch (const cppfmu::FatalError& e) {
         component->logger.Log(fmi3Fatal, "", e.what());

pythonfmu3/pythonfmu-export/src/pythonfmu/PySlaveInstance.cpp

@@ -200,20 +200,46 @@ void PySlaveInstance::ExitInitializationMode()
     });
 }
 
-bool PySlaveInstance::DoStep(cppfmu::FMIFloat64 currentTime, cppfmu::FMIFloat64 stepSize, cppfmu::FMIBoolean, cppfmu::FMIFloat64& endOfStep)
-{
-    bool status;
-    py_safe_run([this, &status, currentTime, stepSize](PyGILState_STATE gilState) {
+cppfmu::FMIStatus PySlaveInstance::DoStep(cppfmu::FMIFloat64 currentTime,
+    cppfmu::FMIFloat64 stepSize,
+    cppfmu::FMIBoolean noSetFmuStatePriorToCurrentPoint,
+    cppfmu::FMIBoolean* eventHandlingNeeded,
+    cppfmu::FMIBoolean* terminateSimulation,
+    cppfmu::FMIBoolean* earlyReturn,
+    cppfmu::FMIFloat64& endOfStep)
+{
+    cppfmu::FMIStatus fmuStatus = cppfmu::FMIOK;
+    py_safe_run([this, &fmuStatus, currentTime, stepSize, terminateSimulation](PyGILState_STATE gilState) {
         auto f = PyObject_CallMethod(pInstance_, "do_step", "(dd)", currentTime, stepSize);
         if (f == nullptr) {
             handle_py_exception("[doStep] PyObject_CallMethod", gilState);
         }
-        status = static_cast<bool>(PyObject_IsTrue(f));
+
+        if (PyObject_HasAttrString(f, "status")) {
+            PyObject* pyStatus = PyObject_GetAttrString(f, "status");
+            if (pyStatus) {
+                fmuStatus = static_cast<cppfmu::FMIStatus>(PyLong_AsLong(pyStatus));
+                Py_DECREF(pyStatus);
+            }
+        } else {
+            bool status = static_cast<bool>(PyObject_IsTrue(f));
+            if (!status) {
+                fmuStatus = cppfmu::FMIDiscard;
+            }
+        }
+
+        if (PyObject_HasAttrString(f, "terminateSimulation")) {
+            PyObject* pyTerminateSimulation = PyObject_GetAttrString(f, "terminateSimulation");
+            if (pyTerminateSimulation) {
+                *terminateSimulation = static_cast<bool>(PyObject_IsTrue(pyTerminateSimulation));
+                Py_DECREF(pyTerminateSimulation);
+            }
+        }
         Py_DECREF(f);
         clearLogBuffer();
     });
 
-    return status;
+    return fmuStatus;
 }
 
 void PySlaveInstance::Reset()

pythonfmu3/pythonfmu-export/src/pythonfmu/PySlaveInstance.hpp

@@ -25,7 +25,13 @@ public:
     void ExitInitializationMode() override;
     void Terminate() override;
     void Reset() override;
-    bool DoStep(cppfmu::FMIFloat64 currentCommunicationPoint, cppfmu::FMIFloat64 communicationStepSize, cppfmu::FMIBoolean newStep, cppfmu::FMIFloat64& endOfStep) override;
+    cppfmu::FMIStatus DoStep(cppfmu::FMIFloat64 currentCommunicationPoint,
+        cppfmu::FMIFloat64 communicationStepSize,
+        cppfmu::FMIBoolean newStep,
+        cppfmu::FMIBoolean* eventHandlingNeeded,
+        cppfmu::FMIBoolean* terminateSimulation,
+        cppfmu::FMIBoolean* earlyReturn,
+        cppfmu::FMIFloat64& endOfStep) override;
 
     void SetFloat64(const cppfmu::FMIValueReference* vr, std::size_t nvr, const cppfmu::FMIFloat64* value, std::size_t nValues) override;
     void SetInt32(const cppfmu::FMIValueReference* vr, std::size_t nvr, const cppfmu::FMIInt32* value) override;

pythonfmu3/tests/slaves/PythonSlaveWithException.py

@@ -1,4 +1,4 @@
-from pythonfmu3.fmi3slave import Fmi3Slave, Fmi3Causality, Float64
+from pythonfmu3.fmi3slave import Fmi3Slave, Fmi3Causality, Float64, Fmi3Variability
 
 
 class PythonSlaveWithException(Fmi3Slave):
@@ -8,6 +8,9 @@ class PythonSlaveWithException(Fmi3Slave):
 
         self.realIn = 22.0
         self.realOut = 0.0
+        self.time = 0
+
+        self.register_variable(Float64("time", causality=Fmi3Causality.independent, variability=Fmi3Variability.continuous))
         self.register_variable(Float64("realIn", causality=Fmi3Causality.input))
         self.register_variable(Float64("realOut", causality=Fmi3Causality.output))
 

pythonfmu3/tests/slaves/pythonslave.py

@@ -21,6 +21,9 @@ class PythonSlave(Fmi3Slave):
         self.realIn = 2. / 3.
         self.booleanParameter = False
         self.stringParameter = "dog"
+        self.time = 0
+
+        self.register_variable(Float64("time", causality=Fmi3Causality.independent, variability=Fmi3Variability.continuous))
         self.register_variable(
             Int32("intParam", causality=Fmi3Causality.parameter, variability=Fmi3Variability.tunable))
         self.register_variable(Float64("realIn", causality=Fmi3Causality.input))

pythonfmu3/tests/slaves/pythonslave_read_file.py

@@ -1,4 +1,4 @@
-from pythonfmu3.fmi3slave import Fmi3Slave, Fmi3Causality, Fmi3Variability, String, DefaultExperiment
+from pythonfmu3.fmi3slave import Fmi3Slave, Fmi3Causality, Fmi3Variability, String, DefaultExperiment, Float64
 
 
 class PythonSlaveReadFile(Fmi3Slave):
@@ -11,6 +11,9 @@ class PythonSlaveReadFile(Fmi3Slave):
         with (open(f'{self.resources}/hello.txt', 'r')) as file:
             data = file.read()
 
+        self.time = 0
+
+        self.register_variable(Float64("time", causality=Fmi3Causality.independent, variability=Fmi3Variability.continuous))
         self.register_variable(
             String("file_content", getter=lambda: data,
                    causality=Fmi3Causality.output,

pythonfmu3/tests/slaves/slavewithdep.py

@@ -1,5 +1,5 @@
 import math
-from pythonfmu3.fmi3slave import Fmi3Slave, Fmi3Causality, Float64
+from pythonfmu3.fmi3slave import Fmi3Slave, Fmi3Causality, Float64, Fmi3Variability
 from localmodule import get_amplitude, get_time_constant
 
 
@@ -10,6 +10,9 @@ class PythonSlaveWithDep(Fmi3Slave):
 
         self.realIn = 22.0
         self.realOut = 0.0
+        self.time = 0
+
+        self.register_variable(Float64("time", causality=Fmi3Causality.independent, variability=Fmi3Variability.continuous))
         self.register_variable(Float64("realIn", causality=Fmi3Causality.input))
         self.register_variable(Float64("realOut", causality=Fmi3Causality.output))
 

pythonfmu3/tests/test_builder.py

@@ -176,3 +176,23 @@ def test_documentation(tmp_path):
 
         assert "documentation/index.html" in names
         assert "documentation/licenses/license.txt" in names
+
+
+def test_terminals(tmp_path):
+    script_file = Path(__file__).parent / "slaves/pythonslave.py"
+    def build():
+        with tempfile.TemporaryDirectory() as terminals_dir:
+            terminals_dir = Path(terminals_dir)
+            terminal1 = terminals_dir / "terminal1.xml"
+            terminal1.write_text("Dummy Terminal 1")
+
+            terminal2 = terminals_dir / "terminal2.xml"
+            terminal2.write_text("Dummy Terminal 2")
+            return FmuBuilder.build_FMU(script_file, dest=tmp_path, terminals_folder=terminals_dir)
+
+    fmu = build()
+    with zipfile.ZipFile(fmu) as files:
+        names = files.namelist()
+
+        assert "terminalsAndIcons/terminal1.xml" in names
+        assert "terminalsAndIcons/terminal2.xml" in names

pythonfmu3/tests/test_integration.py

@@ -38,13 +38,12 @@ def test_integration_reset(tmp_path):
 
     md = fmpy.read_model_description(str(fmu))
     unzipdir = fmpy.extract(str(fmu))
-    model = fmpy.fmi3.FMI3Slave(guid=md.guid,
+    model = fmpy.fmi3.FMU3Slave(guid=md.guid,
                                 unzipDirectory=unzipdir,
                                 modelIdentifier=md.coSimulation.modelIdentifier,
                                 instanceName="instance"
                                 )
     model.instantiate()
-    model.setupExperiment()
     model.enterInitializationMode()
     model.exitInitializationMode()
 
@@ -52,13 +51,13 @@ def test_integration_reset(tmp_path):
     vr = vars["realOut"].valueReference
     dt = 0.1
 
-    initial_value = model.getReal([vr])[0]
+    initial_value = model.getFloat64([vr])[0]
     assert initial_value == pytest.approx(3.0, rel=1e-7)
     model.doStep(0.0, dt, True)
-    read = model.getReal([vr])[0]
+    read = model.getFloat64([vr])[0]
     assert read == pytest.approx(dt, rel=1e-7)
     model.reset()
-    read = model.getReal([vr])[0]
+    read = model.getFloat64([vr])[0]
     assert read == pytest.approx(initial_value, rel=1e-7)
 
     model.terminate()
@@ -77,13 +76,12 @@ def test_integration_get_state(tmp_path):
 
     md = fmpy.read_model_description(str(fmu))
     unzipdir = fmpy.extract(str(fmu))
-    model = fmpy.fmi3.FMI3Slave(guid=md.guid,
+    model = fmpy.fmi3.FMU3Slave(guid=md.guid,
                                 unzipDirectory=unzipdir,
                                 modelIdentifier=md.coSimulation.modelIdentifier,
                                 instanceName="instance"
                                 )
     model.instantiate()
-    model.setupExperiment()
     model.enterInitializationMode()
     model.exitInitializationMode()
 
@@ -98,15 +96,15 @@ def test_integration_get_state(tmp_path):
         t += dt
 
     step_model()
-    state = model.getFMUstate()
-    assert model.getReal([vr])[0] == pytest.approx(dt, rel=1e-7)
+    state = model.getFMUState()
+    assert model.getFloat64([vr])[0] == pytest.approx(dt, rel=1e-7)
     step_model()
-    assert model.getReal([vr])[0] == pytest.approx(dt * 2, rel=1e-7)
-    model.setFMUstate(state)
-    assert model.getReal([vr])[0] == pytest.approx(dt, rel=1e-7)
+    assert model.getFloat64([vr])[0] == pytest.approx(dt * 2, rel=1e-7)
+    model.setFMUState(state)
+    assert model.getFloat64([vr])[0] == pytest.approx(dt, rel=1e-7)
     step_model()
-    assert model.getReal([vr])[0] == pytest.approx(dt * 3, rel=1e-7)
-    model.freeFMUstate(state)
+    assert model.getFloat64([vr])[0] == pytest.approx(dt * 3, rel=1e-7)
+    model.freeFMUState(state)
 
     model.terminate()
     model.freeInstance()
@@ -126,14 +124,13 @@ def test_integration_get_serialize_state(tmp_path):
     md = fmpy.read_model_description(fmu)
     unzip_dir = fmpy.extract(fmu)
 
-    model = fmpy.fmi3.FMI3Slave(
+    model = fmpy.fmi3.FMU3Slave(
         guid=md.guid,
         unzipDirectory=unzip_dir,
         modelIdentifier=md.coSimulation.modelIdentifier,
         instanceName='instance1')
 
     model.instantiate()
-    model.setupExperiment()
     model.enterInitializationMode()
     model.exitInitializationMode()
 
@@ -148,22 +145,22 @@ def test_integration_get_serialize_state(tmp_path):
         t += dt
 
     step_model()
-    state = model.getFMUstate()
-    assert model.getReal(vrs)[0] == pytest.approx(dt, rel=1e-7)
+    state = model.getFMUState()
+    assert model.getFloat64(vrs)[0] == pytest.approx(dt, rel=1e-7)
     step_model()
-    assert model.getReal(vrs)[0] == pytest.approx(dt * 2, rel=1e-7)
-    model.setFMUstate(state)
-    assert model.getReal(vrs)[0] == pytest.approx(dt, rel=1e-7)
+    assert model.getFloat64(vrs)[0] == pytest.approx(dt * 2, rel=1e-7)
+    model.setFMUState(state)
+    assert model.getFloat64(vrs)[0] == pytest.approx(dt, rel=1e-7)
     step_model()
-    assert model.getReal(vrs)[0] == pytest.approx(dt * 3, rel=1e-7)
+    assert model.getFloat64(vrs)[0] == pytest.approx(dt * 3, rel=1e-7)
 
-    serialize_fmu_state = model.serializeFMUstate(state)
-    model.freeFMUstate(state)
-    de_serialize_fmu_state = model.deSerializeFMUstate(serialize_fmu_state)
-    model.setFMUstate(de_serialize_fmu_state)
-    assert model.getReal(vrs)[0] == pytest.approx(dt, rel=1e-7)
+    serialize_fmu_state = model.serializeFMUState(state)
+    model.freeFMUState(state)
+    de_serialize_fmu_state = model.deserializeFMUState(serialize_fmu_state)
+    model.setFMUState(de_serialize_fmu_state)
+    assert model.getFloat64(vrs)[0] == pytest.approx(dt, rel=1e-7)
 
-    model.freeFMUstate(de_serialize_fmu_state)
+    model.freeFMUState(de_serialize_fmu_state)
 
     model.terminate()
     model.freeInstance()
@@ -178,14 +175,13 @@ def test_integration_get(tmp_path):
     md = fmpy.read_model_description(fmu)
     unzip_dir = fmpy.extract(fmu)
 
-    model = fmpy.fmi3.FMI3Slave(
+    model = fmpy.fmi3.FMU3Slave(
         guid=md.guid,
         unzipDirectory=unzip_dir,
         modelIdentifier=md.coSimulation.modelIdentifier,
         instanceName='instance1')
 
     model.instantiate()
-    model.setupExperiment()
     model.enterInitializationMode()
     model.exitInitializationMode()
 
@@ -207,14 +203,14 @@ def test_integration_get(tmp_path):
     for key, value in to_test.items():
         var = variables[key]
         vrs = [var.valueReference]
-        if var.type == "Integer":
-            model_value = model.getInteger(vrs)[0]
-        elif var.type == "Real":
-            model_value = model.getReal(vrs)[0]
+        if var.type == "Int32":
+            model_value = model.getInt32(vrs)[0]
+        elif var.type == "Float64":
+            model_value = model.getFloat64(vrs)[0]
         elif var.type == "Boolean":
             model_value = model.getBoolean(vrs)[0]
         elif var.type == "String":
-            model_value = model.getString(vrs)[0].decode("UTF-8")
+            model_value = model.getString(vrs)[0]
         else:
             pytest.xfail("Unsupported type")
 
@@ -234,20 +230,19 @@ def test_integration_read_from_file(tmp_path):
     md = fmpy.read_model_description(fmu)
     unzip_dir = fmpy.extract(fmu)
 
-    model = fmpy.fmi3.FMI3Slave(
+    model = fmpy.fmi3.FMU3Slave(
         guid=md.guid,
         unzipDirectory=unzip_dir,
         modelIdentifier=md.coSimulation.modelIdentifier,
         instanceName='instance1')
 
     model.instantiate()
-    model.setupExperiment()
     model.enterInitializationMode()
     model.exitInitializationMode()
 
     variables = mapped(md)
     var = variables["file_content"]
-    model_value = model.getString([var.valueReference])[0].decode("UTF-8")
+    model_value = model.getString([var.valueReference])[0]
 
     with (open(project_file, 'r')) as file:
         data = file.read()
@@ -267,14 +262,13 @@ def test_integration_set(tmp_path):
     md = fmpy.read_model_description(fmu)
     unzip_dir = fmpy.extract(fmu)
 
-    model = fmpy.fmi3.FMI3Slave(
+    model = fmpy.fmi3.FMU3Slave(
         guid=md.guid,
         unzipDirectory=unzip_dir,
         modelIdentifier=md.coSimulation.modelIdentifier,
         instanceName='instance1')
 
     model.instantiate()
-    model.setupExperiment()
     model.enterInitializationMode()
     model.exitInitializationMode()
 
@@ -292,18 +286,18 @@ def test_integration_set(tmp_path):
     for key, value in to_test.items():
         var = variables[key]
         vrs = [var.valueReference]
-        if var.type == "Integer":
-            model.setInteger(vrs, [value])
-            model_value = model.getInteger(vrs)[0]
-        elif var.type == "Real":
-            model.setReal(vrs, [value])
-            model_value = model.getReal(vrs)[0]
+        if var.type == "Int32":
+            model.setInt32(vrs, [value])
+            model_value = model.getInt32(vrs)[0]
+        elif var.type == "Float64":
+            model.setFloat64(vrs, [value])
+            model_value = model.getFloat64(vrs)[0]
         elif var.type == "Boolean":
             model.setBoolean(vrs, [value])
             model_value = model.getBoolean(vrs)[0]
         elif var.type == "String":
             model.setString(vrs, [value])
-            model_value = model.getString(vrs)[0].decode("UTF-8")
+            model_value = model.getString(vrs)[0]
         else:
             pytest.xfail("Unsupported type")
 

pythonfmu3/tests/test_multiple_fmus.py

@@ -22,7 +22,7 @@ def mapped(md):
 @pytest.mark.integration
 def test_integration_multiple_fmus(tmp_path):
     slave1_code = """import math
-from pythonfmu3.Fmi3Slave import Fmi3Slave, Fmi3Causality, Int32, Float64, Boolean, String
+from pythonfmu3 import Fmi3Slave, Fmi3Causality, Fmi3Variability, Int32, Float64, Boolean, String
 
 
 class Slave1(Fmi3Slave):
@@ -32,6 +32,8 @@ class Slave1(Fmi3Slave):
 
         self.realIn = 22.0
         self.realOut = 0.0
+        self.time = 0
+        self.register_variable(Float64("time", causality=Fmi3Causality.independent, variability=Fmi3Variability.continuous))
         self.register_variable(Float64("realIn", causality=Fmi3Causality.input))
         self.register_variable(Float64("realOut", causality=Fmi3Causality.output))
 
@@ -41,7 +43,7 @@ class Slave1(Fmi3Slave):
         return True
 """
 
-    slave2_code = """from pythonfmu3.Fmi3Slave import Fmi3Slave, Fmi3Causality, Int32, Float64, Boolean, String
+    slave2_code = """from pythonfmu3 import Fmi3Slave, Fmi3Causality, Fmi3Variability, Int32, Float64, Boolean, String
 
 
 class Slave2(Fmi3Slave):
@@ -51,6 +53,8 @@ class Slave2(Fmi3Slave):
 
         self.realIn = 22.0
         self.realOut = 0.0
+        self.time = 0
+        self.register_variable(Float64("time", causality=Fmi3Causality.independent, variability=Fmi3Variability.continuous))
         self.register_variable(Float64("realIn", causality=Fmi3Causality.input))
         self.register_variable(Float64("realOut", causality=Fmi3Causality.output))
 
@@ -84,21 +88,20 @@ class Slave2(Fmi3Slave):
     md1 = fmpy.read_model_description(fmu1)
     unzip_dir = fmpy.extract(fmu1)
 
-    model1 = fmpy.fmi3.FMI3Slave(
+    model1 = fmpy.fmi3.FMU3Slave(
         guid=md1.guid,
         unzipDirectory=unzip_dir,
         modelIdentifier=md1.coSimulation.modelIdentifier,
         instanceName='instance1')
 
     model1.instantiate()
-    model1.setupExperiment()
     model1.enterInitializationMode()
     model1.exitInitializationMode()
 
     md2 = fmpy.read_model_description(fmu2)
     unzip_dir = fmpy.extract(fmu2)
 
-    model2 = fmpy.fmi3.FMI3Slave(
+    model2 = fmpy.fmi3.FMU3Slave(
         guid=md2.guid,
         unzipDirectory=unzip_dir,
         modelIdentifier=md2.coSimulation.modelIdentifier,
@@ -111,11 +114,10 @@ class Slave2(Fmi3Slave):
     realIn = variables2["realIn"]
 
     model2.instantiate()
-    model2.setupExperiment()
     model2.enterInitializationMode()
 
-    value = model1.getReal([realOut.valueReference])[0]
-    model2.setReal([realIn.valueReference], [value])
+    value = model1.getFloat64([realOut.valueReference])[0]
+    model2.setFloat64([realIn.valueReference], [value])
 
     model2.exitInitializationMode()
 
@@ -125,12 +127,12 @@ class Slave2(Fmi3Slave):
 
     while time < stop_time:
 
-        model2.setReal([realIn.valueReference], [value])
+        model2.setFloat64([realIn.valueReference], [value])
 
         model1.doStep(time, step_size)
         model2.doStep(time, step_size)
 
-        value = model1.getReal([realOut.valueReference])[0]
+        value = model1.getFloat64([realOut.valueReference])[0]
 
         time += step_size
 

{pythonfmu3-0.1.15.dist-info → pythonfmu3-0.1.17.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: pythonfmu3
-Version: 0.1.15
+Version: 0.1.17
 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
@@ -62,7 +62,7 @@ pip install pythonfmu3
 3. Run `pythonfmu3 build` to create the fmu.
 
 ```
-usage: pythonfmu3 build [-h] -f SCRIPT_FILE [-d DEST] [--doc DOCUMENTATION_FOLDER] [--no-external-tool]
+usage: pythonfmu3 build [-h] -f SCRIPT_FILE [-d DEST] [--doc DOCUMENTATION_FOLDER] [--terminals TERMINALS_FOLDER] [--no-external-tool]
                        [--no-variable-step] [--interpolate-inputs] [--only-one-per-process] [--handle-state]
                        [--serialize-state] [--use-memory-management]
                        [Project files [Project files ...]]
@@ -79,6 +79,8 @@ optional arguments:
   -d DEST, --dest DEST  Where to save the FMU.
   --doc DOCUMENTATION_FOLDER
                         Documentation folder to include in the FMU.
+  --terminals TERMINALS_FOLDER
+                        Folder of terminals to include in the FMU.
   --no-external-tool    If given, needsExecutionTool=false
   --no-variable-step    If given, canHandleVariableCommunicationStepSize=false
   --interpolate-inputs  If given, canInterpolateInputs=true

{pythonfmu3-0.1.15.dist-info → pythonfmu3-0.1.17.dist-info}/RECORD

@@ -1,13 +1,13 @@
-pythonfmu3/__init__.py,sha256=PT1R0LpSInyVdXGJbkWMTQym6_SEU7CqUkG7OH5j1f0,396
+pythonfmu3/__init__.py,sha256=oN-2oXyCFwq0gvL2IEf5QvwIXBXZgsSBwAJw7LZ9vzc,424
 pythonfmu3/__main__.py,sha256=gC1T8x2d02hhqshyNQGSS70SyCk-3I3t8zPqoRo2Xd8,1543
-pythonfmu3/_version.py,sha256=qb0TalpSt1CbprnFyeLUKqgrqNtmnk9IoQQ7umAoXVY,23
-pythonfmu3/builder.py,sha256=YLTeLLpiFOkoDYwnJ55GEhb3ham0xxROMjMN6bvaw5Y,8784
+pythonfmu3/_version.py,sha256=BzIjnki8Bz3evNWo6bjGxxpLhy_tN9MRYhtM0MnDiWs,23
+pythonfmu3/builder.py,sha256=ZW-ig7GkWlwGrQ3z8wVsL6j7S6bynWLtL50Sw__M_og,9679
 pythonfmu3/default_experiment.py,sha256=FJ0l0FpU7pT4Pox2RiA2y-Cb_e7DE2XlbWKySRYQaVk,293
 pythonfmu3/deploy.py,sha256=eqFWVxZUkJCLvmq1-GuMNjn2j0VCGoaXPhRWrCk2Vxg,3741
 pythonfmu3/enums.py,sha256=ZmC6vGeBTGt7HarPQ4uYV10ezPsvIxAHH1ypjNq7G3E,729
-pythonfmu3/fmi3slave.py,sha256=7rDp_5TCQnkFLV11UF55mKEvUDXbpZPfn8sOjYCNCSw,16569
+pythonfmu3/fmi3slave.py,sha256=M5zZbsdM8fv8NPfMp9ljyrLcqzE5RSvM3iFz5qyxnN0,16770
 pythonfmu3/logmsg.py,sha256=0wn11GLwq0LLWqyC2ktLRjQFWlpj07wWliZ8rUHx1gg,359
-pythonfmu3/osutil.py,sha256=KMAoMf_BpqFQQUy3WzHnt9jiklkS1xy0syIbj7kNH6A,656
+pythonfmu3/osutil.py,sha256=1qN6qudN4zCupZwc15pzp52WObkqi6jGy9a-MehNt9Q,656
 pythonfmu3/unit.py,sha256=SjOaywb5lVQbAO_iLjc_7Ly3nYrmAvIW2_hAGt12UFU,1475
 pythonfmu3/variable_types.py,sha256=Q0D4wlGi3i3zE5UsmGJEpNh7SV_W8mn_8p_WIkwrLQA,2881
 pythonfmu3/variables.py,sha256=hwYT6AfaSQIa1egVJrOxnDi5NEj1bk_VkQd9-hsoDII,11905
@@ -16,39 +16,39 @@ pythonfmu3/pythonfmu-export/CMakeLists.txt,sha256=p0-4Xh_sAaOI9AVb8lsUsMxJPc6bg9
 pythonfmu3/pythonfmu-export/build_unix.sh,sha256=I5RrF2O6y0hRG_SN4ExKN_CCFYaa2l-ngKzqmBXnHmA,73
 pythonfmu3/pythonfmu-export/build_win.sh,sha256=UzmAcWqFmwBu6mvYne2Dx3UK8iPwTtP4HpjICsjUaJA,97
 pythonfmu3/pythonfmu-export/src/CMakeLists.txt,sha256=RyjGhUUDhG_HEieCdt5WMfTR1snofOqigEKc83_zvfE,1104
-pythonfmu3/pythonfmu-export/src/cppfmu/cppfmu_common.hpp,sha256=k6TEU6J6fe6RJWxsvA4uA2W4BRQriPnkQX4GKdM-MgA,4465
+pythonfmu3/pythonfmu-export/src/cppfmu/cppfmu_common.hpp,sha256=cgrlZa5L-bbjZeVi0pmy4JKE5UJ2GszzuyOqTdRcBRQ,4353
 pythonfmu3/pythonfmu-export/src/cppfmu/cppfmu_cs.cpp,sha256=EsUIevwmCzX9hsui3i8x1crSnSOG8dEK15Zm1ZIavYQ,3843
-pythonfmu3/pythonfmu-export/src/cppfmu/cppfmu_cs.hpp,sha256=v4Fb8gOWk2tsUgnuQ2NBeqwc3EFQhWRxvDYHtL1C0zk,6144
-pythonfmu3/pythonfmu-export/src/cppfmu/fmi_functions.cpp,sha256=sTHQVUCH_dwIxRl6u1VRNkTb1MRUoVlQLGpTPh5WQdk,25505
+pythonfmu3/pythonfmu-export/src/cppfmu/cppfmu_cs.hpp,sha256=UmqAVAVE1KHNHMC8mIh8gIHRJ_aQk0Ma139TU6Kvv4o,6264
+pythonfmu3/pythonfmu-export/src/cppfmu/fmi_functions.cpp,sha256=FL8TveY4TNAbtrgzElC4WliY8C1vOfvtd5Sh2CcVFgc,25610
 pythonfmu3/pythonfmu-export/src/fmi/fmi3FunctionTypes.h,sha256=Tk1WY0nAYBGiOAQ8zVbmqRAfdQttITWsLba7udhBwG4,30050
 pythonfmu3/pythonfmu-export/src/fmi/fmi3Functions.h,sha256=NsHuclp20wcuUInYf-91UXZbljTeu2cPXENqNEORdgU,16262
 pythonfmu3/pythonfmu-export/src/fmi/fmi3PlatformTypes.h,sha256=ZCQLJgSbRGrMsBiQ4auaYCY4J3Hck6g3t1iZp5NEguw,4251
 pythonfmu3/pythonfmu-export/src/pythonfmu/IPyState.hpp,sha256=GLiOjhKLDVEICersnqVwezwEshbxfdh_cyMxBJGFbu8,456
-pythonfmu3/pythonfmu-export/src/pythonfmu/PySlaveInstance.cpp,sha256=pzHSx3Cfq7Lt7dcvMR5na7tyOrTs0RsNglnrAcRc0cs,24333
-pythonfmu3/pythonfmu-export/src/pythonfmu/PySlaveInstance.hpp,sha256=Q8eulMAkv7YkfzCi2KSwxvYngv0I_nRbmfTJR9vT92M,4063
+pythonfmu3/pythonfmu-export/src/pythonfmu/PySlaveInstance.cpp,sha256=MpEUUcxPwoJlM_mW-9qxj4ezgKQd-CkDc2ud0mM7HbQ,25362
+pythonfmu3/pythonfmu-export/src/pythonfmu/PySlaveInstance.hpp,sha256=T-epGp68SjhDv-JupxUe2ZgnV8unU4htc-PUBokjWm4,4239
 pythonfmu3/pythonfmu-export/src/pythonfmu/PyState.hpp,sha256=CjFEIrZu8b1jxQAIgfI_o36hyItW_SdQ5VSkImf7JNs,2977
-pythonfmu3/resources/binaries/x86_64-linux/libpythonfmu-export.so,sha256=abssHrtFiwtjugmJkjHL29TqmimbkydTsAEr5k7ryKc,365120
-pythonfmu3/resources/binaries/x86_64-windows/pythonfmu-export.dll,sha256=5S2ivGp0No5x-vJjb9iWBf2m7SLvDw_gcTgQycTcdKk,431104
+pythonfmu3/resources/binaries/x86_64-linux/libpythonfmu-export.so,sha256=LLTlb6TDjJ24xuy7zhO5Sbj39nVzQSODkkXMXGl8Y7s,365224
+pythonfmu3/resources/binaries/x86_64-windows/pythonfmu-export.dll,sha256=b22hsx-MKU7vhYcbLViGyAfd0Jxv29sx0mxtWO3S7u0,430592
 pythonfmu3/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pythonfmu3/tests/conftest.py,sha256=B6XxTnBdeF_tEJ3w2DlfPKUfvlk-oULgIhQtXkgOJIc,171
-pythonfmu3/tests/test_builder.py,sha256=StR9oNmF6dtuxxKtPFlncLQN-O7n97nvHm6EFH4Qn14,6252
+pythonfmu3/tests/test_builder.py,sha256=gxelTXyk03VreAy5ptQRQtl20IstO9eWTifTSvTceiE,7004
 pythonfmu3/tests/test_deploy.py,sha256=JCDo-O93-izxrP9Q4K0njBcfZ-gAXYx9aZ4plgctz7k,1783
 pythonfmu3/tests/test_fmi3slave.py,sha256=1uwTdfiFZNmU0yzIdC30kAuu95xsZSTMA9CGk_Kdmm4,4304
-pythonfmu3/tests/test_integration.py,sha256=2ewA-Mai5qbC5ujyYDLo_Em1NzGsfrgaYiugDZH53ow,10562
+pythonfmu3/tests/test_integration.py,sha256=zA3iJ4rI2cKEE8mDsAmcVuwNWlJzhonV8Wxz92hzEac,10387
 pythonfmu3/tests/test_logger.py,sha256=OcHQhxUtNBPH-0zdmheC4I9OWz1yu48W8MYDshNVkf8,5765
-pythonfmu3/tests/test_multiple_fmus.py,sha256=NJC3aHu1PA4LlZjMmCfC3IKh-_IBu1h3QMkrKiDYFrY,3680
+pythonfmu3/tests/test_multiple_fmus.py,sha256=-sthCm2YUZiRkdfvpLQNgquPBForUKQ7HGqfFBdrRas,3942
 pythonfmu3/tests/test_variables.py,sha256=t4r2TBruf58uYwjkp3r-RcZS5TrsOaVT_mDuoiUTQtg,9598
 pythonfmu3/tests/utils.py,sha256=WusWSUGoBPenZL-FAKQlzaHN2aYXiznZM2fwCjoldwY,301
 pythonfmu3/tests/data/csvdemo.csv,sha256=TiTUyzHyjQNXM4eXI33oJipc7w9_PJ8aMejRmwc52Xw,256
 pythonfmu3/tests/data/hello.txt,sha256=wFNeS-K3n_2TKRMFQ2v4iTFOSj-uwF7P_Lt98xrZ5Ro,12
-pythonfmu3/tests/slaves/PythonSlaveWithException.py,sha256=SUSjrba1mZBT_2pOYNQi2fEv8Ns5QWDM5zYps__4NJM,479
+pythonfmu3/tests/slaves/PythonSlaveWithException.py,sha256=lTTMMnD5Cu09HzA8G2masKyf-ntEMfJ0a3M8btdYVLo,644
 pythonfmu3/tests/slaves/localmodule.py,sha256=-q5Lmh2I88MG7nLTscms0n5xhHLkUDed1IuQ5wj49lo,79
-pythonfmu3/tests/slaves/pythonslave.py,sha256=H75vLhqshSWWvMj2NQt6a_aQhA6BGSkBVJstjjVE0AU,2024
-pythonfmu3/tests/slaves/pythonslave_read_file.py,sha256=NIAmyZZGNAcnqf8R5jb1yFcQxj6iSMOAc13pY0GFtco,634
-pythonfmu3/tests/slaves/slavewithdep.py,sha256=4yqxa0vsOTLLvtaUQFkjfU9OcwjDUtuUe-qIjnD-jrw,647
-pythonfmu3-0.1.15.dist-info/LICENSE,sha256=24Cw_MPouLK-G_t8Hgjm59IS9BnPoL6SKkyuZ0xesXY,1155
-pythonfmu3-0.1.15.dist-info/METADATA,sha256=wLt8-BEWjeq7FO4G_YnSEQXUd2387gE_YhY3oW4v3hc,7442
-pythonfmu3-0.1.15.dist-info/WHEEL,sha256=UvcQYKBHoFqaQd6LKyqHw9fxEolWLQnlzP0h_LgJAfI,91
-pythonfmu3-0.1.15.dist-info/entry_points.txt,sha256=GgkWYs0DKGHLcijMEYZGkhkHOK2RVUpjGwvl1fwyDwQ,60
-pythonfmu3-0.1.15.dist-info/top_level.txt,sha256=6ne7bh_cME1hepxCx1BG8N5QVhVAufrp7LLok6vq7nE,11
-pythonfmu3-0.1.15.dist-info/RECORD,,
+pythonfmu3/tests/slaves/pythonslave.py,sha256=uzrTQmfk0QBalxNTviGMZNph_YgVmcbxPqKgX5rSvXg,2172
+pythonfmu3/tests/slaves/pythonslave_read_file.py,sha256=t2sDaZSr2veD91gdqCO9W9CN-AN3TyXABXXfV9Rt0Xs,791
+pythonfmu3/tests/slaves/slavewithdep.py,sha256=hHDFB0dw8wkHiGzxeAVbz9O5LR6ghsFeONgRFdiK_t0,812
+pythonfmu3-0.1.17.dist-info/LICENSE,sha256=24Cw_MPouLK-G_t8Hgjm59IS9BnPoL6SKkyuZ0xesXY,1155
+pythonfmu3-0.1.17.dist-info/METADATA,sha256=JnvWnoH6HzMnzQiBmd6P9J5goxKpqPdGYQcMO4Aalo4,7571
+pythonfmu3-0.1.17.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+pythonfmu3-0.1.17.dist-info/entry_points.txt,sha256=GgkWYs0DKGHLcijMEYZGkhkHOK2RVUpjGwvl1fwyDwQ,60
+pythonfmu3-0.1.17.dist-info/top_level.txt,sha256=6ne7bh_cME1hepxCx1BG8N5QVhVAufrp7LLok6vq7nE,11
+pythonfmu3-0.1.17.dist-info/RECORD,,

{pythonfmu3-0.1.15.dist-info → pythonfmu3-0.1.17.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (74.0.0)
+Generator: setuptools (75.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any