pythonfmu3 0.1.16__tar.gz → 0.1.18__tar.gz

{pythonfmu3-0.1.16/pythonfmu3.egg-info → pythonfmu3-0.1.18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: pythonfmu3
-Version: 0.1.16
+Version: 0.1.18
 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_FILE] [--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_FILE
+                        Terminals file (terminalsAndIcons.xml) 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.16 → pythonfmu3-0.1.18}/README.md

@@ -36,7 +36,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_FILE] [--no-external-tool]
                        [--no-variable-step] [--interpolate-inputs] [--only-one-per-process] [--handle-state]
                        [--serialize-state] [--use-memory-management]
                        [Project files [Project files ...]]
@@ -53,6 +53,8 @@ optional arguments:
   -d DEST, --dest DEST  Where to save the FMU.
   --doc DOCUMENTATION_FOLDER
                         Documentation folder to include in the FMU.
+  --terminals TERMINALS_FILE
+                        Terminals file (terminalsAndIcons.xml) 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.16 → pythonfmu3-0.1.18}/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-0.1.18/pythonfmu3/_version.py

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

{pythonfmu3-0.1.16 → pythonfmu3-0.1.18}/pythonfmu3/builder.py

@@ -66,6 +66,7 @@ class FmuBuilder:
         dest: FilePath = ".",
         project_files: Iterable[FilePath] = set(),
         documentation_folder: Optional[FilePath] = None,
+        terminals : Optional[FilePath] = None,
         **options,
     ) -> Path:
         script_file = Path(script_file)
@@ -85,6 +86,17 @@ class FmuBuilder:
                 raise ValueError(
                     f"The documentation folder does not exists {documentation_folder!s}"
                 )
+        
+        if terminals is not None:
+            terminals = Path(terminals)
+            if not terminals.exists():
+                raise ValueError(
+                    f"The specified terminalsAndIcons file does not exists {terminals!s}"
+                )
+            if not terminals.name == "terminalsAndIcons.xml":
+                raise ValueError(
+                    f"Incorrect terminal name {terminals!s}. Terminal file must be named terminalsAndIcons.xml"
+                )
 
         module_name = script_file.stem
 
@@ -178,6 +190,12 @@ class FmuBuilder:
                             relative_f = f.relative_to(documentation_folder)
                             zip_fmu.write(f, arcname=(documentation / relative_f))
 
+                if terminals is not None:
+                    terminalsFolder = Path("terminalsAndIcons")
+                    relative_f = terminals.relative_to(terminals.parent)
+                    zip_fmu.write(f, arcname=(terminalsFolder / relative_f))
+                    
+
                 # Add the model description
                 xml_str = parseString(tostring(xml, "UTF-8"))
                 zip_fmu.writestr(
@@ -215,6 +233,13 @@ def create_command_parser(parser: argparse.ArgumentParser):
         default=None
     )
 
+    parser.add_argument(
+        "--terminals",
+        dest="terminals",
+        help="Terminals file (terminalsAndIcons.xml) 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-0.1.16 → pythonfmu3-0.1.18}/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-0.1.16 → pythonfmu3-0.1.18}/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-0.1.16 → pythonfmu3-0.1.18}/pythonfmu3/pythonfmu-export/src/cppfmu/fmi_functions.cpp

@@ -50,7 +50,7 @@ struct Component
     Component(cppfmu::FMIComponentEnvironment instanceEnvironment,
         cppfmu::FMICallbackLogger logCallback,
         cppfmu::FMIBoolean loggingOn) : loggerSettings{std::make_shared<cppfmu::Logger::Settings>()},
-        logger{instanceEnvironment, 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
 
@@ -659,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-0.1.16 → pythonfmu3-0.1.18}/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-0.1.16 → pythonfmu3-0.1.18}/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-0.1.16 → pythonfmu3-0.1.18}/pythonfmu3/tests/test_builder.py

@@ -176,3 +176,20 @@ 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)
+            terminals = terminals_dir / "terminalsAndIcons.xml"
+            terminals.write_text("Dummy Terminal 1")
+
+            return FmuBuilder.build_FMU(script_file, dest=tmp_path, terminals=terminals)
+
+    fmu = build()
+    with zipfile.ZipFile(fmu) as files:
+        names = files.namelist()
+
+        assert "terminalsAndIcons/terminalsAndIcons.xml" in names

{pythonfmu3-0.1.16 → pythonfmu3-0.1.18/pythonfmu3.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: pythonfmu3
-Version: 0.1.16
+Version: 0.1.18
 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_FILE] [--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_FILE
+                        Terminals file (terminalsAndIcons.xml) 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.16/pythonfmu3/_version.py

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