fmu-manipulation-toolbox 1.9rc10__tar.gz → 1.9.1__tar.gz

{fmu_manipulation_toolbox-1.9rc10 → fmu_manipulation_toolbox-1.9.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fmu_manipulation_toolbox
-Version: 1.9rc10
+Version: 1.9.1
 Summary: FMU Manipulation Toolbox is a python application for modifying Functional Mock-up Units (FMUs) without recompilation or bundling them into FMU Containers
 Home-page: https://github.com/grouperenault/fmu_manipulation_toolbox/
 Author: Nicolas.LAURENT@Renault.com

{fmu_manipulation_toolbox-1.9rc10 → fmu_manipulation_toolbox-1.9.1}/fmu_manipulation_toolbox/__main__.py

@@ -11,7 +11,7 @@ def gui():
 
 def cli():
     from .cli.fmutool import fmutool
-    fmutool()
+    fmutool(sys.argv[1:])
 
 
 def main():

fmu_manipulation_toolbox-1.9.1/fmu_manipulation_toolbox/__version__.py

@@ -0,0 +1 @@
+'V1.9.1'

{fmu_manipulation_toolbox-1.9rc10 → fmu_manipulation_toolbox-1.9.1}/fmu_manipulation_toolbox/assembly.py

@@ -38,7 +38,8 @@ class Connection:
 
 class AssemblyNode:
     def __init__(self, name: Optional[str], step_size: float = None, mt=False, profiling=False, sequential=False,
-                 auto_link=True, auto_input=True, auto_output=True, auto_parameter=False, auto_local=False):
+                 auto_link=True, auto_input=True, auto_output=True, auto_parameter=False, auto_local=False,
+                 ts_multiplier=False):
         self.name = name
         if step_size:
             try:
@@ -56,6 +57,7 @@ class AssemblyNode:
         self.auto_output = auto_output
         self.auto_parameter = auto_parameter
         self.auto_local = auto_local
+        self.ts_multiplier = ts_multiplier
 
         self.parent: Optional[AssemblyNode] = None
         self.children: Dict[str, AssemblyNode] = {}     # sub-containers
@@ -141,7 +143,7 @@ class AssemblyNode:
             self.add_link(link_rule[0], link_rule[1], link_rule[2], link_rule[3])
 
         container.make_fmu(self.name, self.step_size, mt=self.mt, profiling=self.profiling, sequential=self.sequential,
-                           debug=debug)
+                           debug=debug, ts_multiplier=self.ts_multiplier)
 
         for node in self.children.values():
             logger.info(f"Deleting transient FMU Container '{node.name}'")
@@ -221,7 +223,7 @@ class AssemblyError(Exception):
 class Assembly:
     def __init__(self, filename: str, step_size=None, auto_link=True,  auto_input=True, debug=False, sequential=False,
                  auto_output=True, mt=False, profiling=False, fmu_directory: Path = Path("."), auto_parameter=False,
-                 auto_local=False):
+                 auto_local=False, ts_multiplier=False):
         self.filename = Path(filename)
         self.default_auto_input = auto_input
         self.debug = debug
@@ -233,6 +235,7 @@ class Assembly:
         self.default_mt = mt
         self.default_sequential = sequential
         self.default_profiling = profiling
+        self.default_ts_multiplier = ts_multiplier
         self.fmu_directory = fmu_directory
         self.transient_filenames: List[Path] = []
         self.transient_dirnames: Set[Path] = set()
@@ -289,7 +292,7 @@ class Assembly:
                                  mt=self.default_mt, profiling=self.default_profiling,
                                  sequential=self.default_sequential, auto_input=self.default_auto_input,
                                  auto_output=self.default_auto_output, auto_parameter=self.default_auto_parameter,
-                                 auto_local=self.default_auto_local)
+                                 auto_local=self.default_auto_local, ts_multiplier=self.default_ts_multiplier)
 
         with open(self.input_pathname) as file:
             reader = csv.reader(file, delimiter=';')
@@ -397,15 +400,16 @@ class Assembly:
         auto_parameter = data.get("auto_parameter", self.default_auto_parameter)            # 6b
         auto_local = data.get("auto_local", self.default_auto_local)                        # 6c
         step_size = data.get("step_size", self.default_step_size)                           # 7
+        ts_multiplier = data.get("ts_multiplier", self.default_ts_multiplier)               # 7b
 
         node = AssemblyNode(name, step_size=step_size, auto_link=auto_link, mt=mt, profiling=profiling,
                             sequential=sequential,
                             auto_input=auto_input, auto_output=auto_output, auto_parameter=auto_parameter,
-                            auto_local=auto_local)
+                            auto_local=auto_local, ts_multiplier=ts_multiplier)
 
         for key, value in data.items():
             if key in ('name', 'step_size', 'auto_link', 'auto_input', 'auto_output', 'mt', 'profiling', 'sequential',
-                       'auto_parameter', 'auto_local'):
+                       'auto_parameter', 'auto_local', 'ts_multiplier'):
                 continue  # Already read
 
             elif key == "container":  # 8
@@ -472,6 +476,9 @@ class Assembly:
         if node.step_size:
             json_node["step_size"] = node.step_size        # 7
 
+        if node.ts_multiplier:
+            json_node["ts_multiplier"] = node.ts_multiplier # 7b
+
         if node.children:
             json_node["container"] = [self._json_encode_node(child) for child in node.children.values()]  # 8
 

{fmu_manipulation_toolbox-1.9rc10 → fmu_manipulation_toolbox-1.9.1}/fmu_manipulation_toolbox/checker.py

@@ -2,8 +2,11 @@ import importlib.util
 import inspect
 import logging
 import os
+import sys
 import xmlschema
+from typing import *
 from xmlschema.validators.exceptions import XMLSchemaValidationError
+
 from .operations import OperationAbstract
 
 logger = logging.getLogger("fmu_manipulation_toolbox")
@@ -40,8 +43,24 @@ class OperationGenericCheck(OperationAbstract):
         else:
             logger.error(f"This FMU does not validate with FMI standard.")
 
+_checkers_list: List[type[OperationAbstract]] = [OperationGenericCheck]
+
+def get_checkers() -> List[type[OperationAbstract]]:
+    if sys.version_info < (3, 10):
+        from importlib_metadata import entry_points
+    else:
+        from importlib.metadata import entry_points
+    checkers: List[type[OperationAbstract]] = _checkers_list
+    discovered_checkers = entry_points(group='fmu_manipulation_toolbox.checkers')
+
+    for checker in discovered_checkers:
+        entry = checker.load()
+        checker_class = entry()
+        if issubclass(checker_class, OperationAbstract):
+            logger.debug(f"Addon checker: {checker.name}")
+            checkers.append(checker_class)
 
-checker_list = [OperationGenericCheck]
+    return checkers
 
 
 def add_from_file(checker_filename: str):
@@ -59,7 +78,7 @@ def add_from_file(checker_filename: str):
 
         for checker_name, checker_class in inspect.getmembers(checker_module, inspect.isclass):
             if OperationAbstract in checker_class.__bases__:
-                checker_list.append(checker_class)
+                _checkers_list.append(checker_class)
                 logger.info(f"Adding checker: {checker_filename}|{checker_name}")
 
     except AttributeError:

{fmu_manipulation_toolbox-1.9rc10 → fmu_manipulation_toolbox-1.9.1}/fmu_manipulation_toolbox/cli/fmucontainer.py

@@ -65,6 +65,9 @@ def fmucontainer(command_options: Sequence[str]):
     parser.add_argument("-dump-json",  action="store_true", dest="dump", default=False,
                         help="Dump a JSON file for each container.")
 
+    parser.add_argument("-vr", action="store_true", dest="ts_multiplier", default=False,
+                        help="Add TS_MULTIPLIER input port to control step_size")
+
     config = parser.parse_args(command_options)
 
     if config.debug:
@@ -87,7 +90,7 @@ def fmucontainer(command_options: Sequence[str]):
                                 auto_input=config.auto_input, auto_output=config.auto_output,
                                 auto_local=config.auto_local, mt=config.mt, sequential=config.sequential,
                                 profiling=config.profiling, fmu_directory=fmu_directory, debug=config.debug,
-                                auto_parameter=config.auto_parameter)
+                                auto_parameter=config.auto_parameter, ts_multiplier=config.ts_multiplier)
         except FileNotFoundError as e:
             logger.fatal(f"Cannot read file: {e}")
             sys.exit(-1)

{fmu_manipulation_toolbox-1.9rc10 → fmu_manipulation_toolbox-1.9.1}/fmu_manipulation_toolbox/cli/fmutool.py

@@ -9,7 +9,7 @@ from ..operations import (OperationSummary, OperationError, OperationRemoveRegex
                           OperationStripTopLevel, OperationRenameFromCSV, OperationSaveNamesToCSV, FMU, FMUError)
 from ..remoting import  (OperationAddFrontendWin32, OperationAddFrontendWin64, OperationAddRemotingWin32,
                          OperationAddRemotingWin64)
-from ..checker import checker_list
+from ..checker import get_checkers
 from ..version import __version__ as version
 from ..help import Help
 
@@ -69,7 +69,7 @@ def fmutool(command_options: Sequence[str]):
     add_option('-only-locals', action='append_const', dest='apply_on', const='local')
     # Checker
     add_option('-summary', action='append_const', dest='operations_list', const=OperationSummary())
-    add_option('-check', action='append_const', dest='operations_list', const=[checker() for checker in checker_list])
+    add_option('-check', action='append_const', dest='operations_list', const=[checker() for checker in get_checkers()])
 
     cli_options = parser.parse_args(command_options)
     # handle the "no operation" use case

{fmu_manipulation_toolbox-1.9rc10 → fmu_manipulation_toolbox-1.9.1}/fmu_manipulation_toolbox/container.py

@@ -426,7 +426,7 @@ class FMUContainer:
     <Category name="fmucontainer"/>
   </LogCategories>
 
-  <DefaultExperiment stepSize="{step_size}" startTime="{start_time}" stopTime="{stop_time}"/>
+  <DefaultExperiment stepSize="{step_size}"{default_experiment_times}/>
 
   <ModelVariables>
     <ScalarVariable valueReference="0" name="time" causality="independent"><Real /></ScalarVariable>
@@ -460,7 +460,7 @@ class FMUContainer:
     <Category name="fmucontainer"/>
   </LogCategories>
 
-  <DefaultExperiment stepSize="{step_size}" startTime="{start_time}" stopTime="{stop_time}"/>
+  <DefaultExperiment stepSize="{step_size}"{default_experiment_times}/>
 
   <ModelVariables>
     <Float64 valueReference="0" name="time" causality="independent"/>
@@ -681,7 +681,7 @@ class FMUContainer:
                         logger.warning(f"{cport} is not connected")
 
     def make_fmu(self, fmu_filename: Union[str, Path], step_size: Optional[float] = None, debug=False, mt=False,
-                 profiling=False, sequential=False):
+                 profiling=False, sequential=False, ts_multiplier=False):
         if isinstance(fmu_filename, str):
             fmu_filename = Path(fmu_filename)
 
@@ -695,7 +695,7 @@ class FMUContainer:
         base_directory = self.fmu_directory / fmu_filename.with_suffix('')
         resources_directory = self.make_fmu_skeleton(base_directory)
         with open(base_directory / "modelDescription.xml", "wt") as xml_file:
-            self.make_fmu_xml(xml_file, step_size, profiling)
+            self.make_fmu_xml(xml_file, step_size, profiling, ts_multiplier)
         with open(resources_directory / "container.txt", "wt") as txt_file:
             self.make_fmu_txt(txt_file, step_size, mt, profiling, sequential)
 
@@ -703,7 +703,7 @@ class FMUContainer:
         if not debug:
             self.make_fmu_cleanup(base_directory)
 
-    def make_fmu_xml(self, xml_file, step_size: float, profiling: bool):
+    def make_fmu_xml(self, xml_file, step_size: float, profiling: bool, ts_multiplier: bool):
         timestamp = datetime.now().strftime('%Y-%m-%dT%H:%M:%SZ')
         guid = str(uuid.uuid4())
         embedded_fmu = ", ".join([fmu_name for fmu_name in self.involved_fmu])
@@ -732,13 +732,19 @@ class FMUContainer:
         else:
             logger.info(f"stop_time={self.stop_time}")
 
+        default_experiment_times = ""
+        if self.start_time is not None:
+            default_experiment_times += f' startTime="{self.start_time}"'
+        if self.stop_time is not None:
+            default_experiment_times += f' stopTime="{self.stop_time}"'
+
         if self.fmi_version == 2:
             xml_file.write(self.HEADER_XML_2.format(identifier=self.identifier, tool_version=tool_version,
                                                     timestamp=timestamp, guid=guid, embedded_fmu=embedded_fmu,
                                                     author=author,
                                                     only_once=capabilities['canBeInstantiatedOnlyOncePerProcess'],
                                                     execution_tool=capabilities['needsExecutionTool'],
-                                                    start_time=self.start_time, stop_time=self.stop_time,
+                                                    default_experiment_times=default_experiment_times,
                                                     step_size=step_size))
         elif self.fmi_version == 3:
             xml_file.write(self.HEADER_XML_3.format(identifier=self.identifier, tool_version=tool_version,
@@ -746,12 +752,24 @@ class FMUContainer:
                                                     author=author,
                                                     only_once=capabilities['canBeInstantiatedOnlyOncePerProcess'],
                                                     execution_tool=capabilities['needsExecutionTool'],
-                                                    start_time=self.start_time, stop_time=self.stop_time,
+                                                    default_experiment_times=default_experiment_times,
                                                     step_size=step_size))
 
         vr_time = self.vr_table.add_vr("real64", local=True)
         logger.debug(f"Time vr = {vr_time}")
 
+        vr_ts_multiplier = self.vr_table.add_vr("integer32", local=True)
+        if ts_multiplier:
+            logger.debug(f"TS Multiplier vr = {vr_ts_multiplier}")
+            port = EmbeddedFMUPort("integer32", {"valueReference": vr_ts_multiplier,
+                                                 "name": f"container.ts_multiplier",
+                                                 "causality": "input",
+                                                 "description": f"Timestep multiplier",
+                                                 "variability": "discrete",
+                                                 "start": 1,
+                                                 "initial": "exact"})
+            print(f"    {port.xml(vr_ts_multiplier, fmi_version=self.fmi_version)}", file=xml_file)
+
         if profiling:
             for fmu in self.involved_fmu.values():
                 vr = self.vr_table.add_vr("real64", local=True)
@@ -915,6 +933,8 @@ class FMUContainer:
                 if profiling:
                     for profiling_port, _ in enumerate(self.involved_fmu.values()):
                         print(f"{profiling_port + 1} 1 -2 {profiling_port + 1}", file=txt_file)
+            elif type_name == "integer32":
+                print(f"0 1 -1 0", file=txt_file)  # TS Multiplier
 
             for input_port in inputs_per_type[type_name]:
                 cport_string = [f"{fmu_rank[cport.fmu.name]} {cport.port.vr}" for cport in input_port.cport_list]

{fmu_manipulation_toolbox-1.9rc10 → fmu_manipulation_toolbox-1.9.1}/fmu_manipulation_toolbox/gui.py

@@ -16,7 +16,7 @@ from .operations import *
 from .remoting import (OperationAddRemotingWin32, OperationAddRemotingWin64, OperationAddFrontendWin32,
                        OperationAddFrontendWin64)
 from .assembly import Assembly, AssemblyNode
-from .checker import checker_list
+from .checker import get_checkers
 from .help import Help
 from .version import __version__ as version
 
@@ -414,7 +414,7 @@ class MainWindow(WindowWithLayout):
             ("Add Win64 remoting",    '-add-remoting-win64', 'info',    OperationAddRemotingWin64),
             ("Add Win32 frontend",    '-add-frontend-win32', 'info',    OperationAddFrontendWin32),
             ("Add Win64 frontend",    '-add-frontend-win64', 'info',    OperationAddFrontendWin64),
-            ("Check",                 '-check',              'info',    checker_list),
+            ("Check",                 '-check',              'info',    get_checkers()),
         ]
 
         width = 5

{fmu_manipulation_toolbox-1.9rc10 → fmu_manipulation_toolbox-1.9.1}/fmu_manipulation_toolbox/operations.py

@@ -69,7 +69,13 @@ class FMUPort:
             print(f"      <{self.fmi_type} {self.dict_level(1)}/>", file=file)
             print(f"    </ScalarVariable>", file=file)
         elif fmi_version == 3:
-            print(f"    <{self.fmi_type} {self.dict_level(0)}/>", file=file)
+            start_value = self.get("start", "")
+            if self.fmi_type in ("String", "Binary") and start_value:
+                print(f"    <{self.fmi_type} {self.dict_level(0)}>", file=file)
+                print(f'      <Start value="{start_value}"/>', file=file)
+                print(f"    </{self.fmi_type}>", file=file)
+            else:
+                print(f"    <{self.fmi_type} {self.dict_level(0)}/>", file=file)
         else:
             raise FMUError(f"FMUPort writing: unsupported FMI version {fmi_version}")
 
@@ -177,6 +183,8 @@ class Manipulation:
                 self.current_port = FMUPort()
                 self.current_port.fmi_type = name
                 self.current_port.push_attrs(attrs)
+            elif self.fmu.fmi_version == 3 and name == "Start":
+                self.current_port.push_attrs({"start": attrs.get("value", "")})
             elif name == 'CoSimulation':
                 self.operation.cosimulation_attrs(attrs)
             elif name == 'DefaultExperiment':

{fmu_manipulation_toolbox-1.9rc10 → fmu_manipulation_toolbox-1.9.1}/fmu_manipulation_toolbox.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fmu_manipulation_toolbox
-Version: 1.9rc10
+Version: 1.9.1
 Summary: FMU Manipulation Toolbox is a python application for modifying Functional Mock-up Units (FMUs) without recompilation or bundling them into FMU Containers
 Home-page: https://github.com/grouperenault/fmu_manipulation_toolbox/
 Author: Nicolas.LAURENT@Renault.com

{fmu_manipulation_toolbox-1.9rc10 → fmu_manipulation_toolbox-1.9.1}/tests/test_suite.py

@@ -190,6 +190,12 @@ class FMUManipulationToolboxTestSuite(unittest.TestCase):
         assembly.make_fmu()
         self.assert_simulation("containers/VanDerPol/VanDerPol-Container.fmu", 0.1)
 
+    def test_container_vanderpol_vr(self):
+        assembly = Assembly("VanDerPol-vr.json", fmu_directory=Path("containers/VanDerPol"))
+        assembly.make_fmu()
+        if os.name == 'nt':
+            self.assert_simulation("containers/VanDerPol/VanDerPol-vr2.fmu", 0.1)
+
     def test_fmi3_pt2(self):
         assembly = Assembly("passthrough.json", fmu_directory=Path("fmi3/passthrough"), debug=True)
         assembly.make_fmu(fmi_version=2)

fmu_manipulation_toolbox-1.9rc10/fmu_manipulation_toolbox/__version__.py

@@ -1 +0,0 @@
-'V1.9-rc10'