fmu-manipulation-toolbox 1.8.4.3b0__tar.gz → 1.9rc0__tar.gz

{fmu_manipulation_toolbox-1.8.4.3b0 → fmu_manipulation_toolbox-1.9rc0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fmu_manipulation_toolbox
-Version: 1.8.4.3b0
+Version: 1.9rc0
 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.8.4.3b0 → fmu_manipulation_toolbox-1.9rc0}/README.md

@@ -131,24 +131,29 @@ optional arguments:
 ### FMU Containers
 
 ```
-usage: fmucontainer [-h] [-fmu-directory FMU_DIRECTORY] -container filename.{csv|json|ssp},[:step_size] [-debug]
-                    [-no-auto-input] [-no-auto-output] [-auto-parameter] [-no-auto-link] [-mt] [-profile] [-dump-json]
+usage: fmucontainer [-h] [-fmu-directory FMU_DIRECTORY] [-fmi FMI_VERSION]
+                    -container filename.{csv|json|ssp},[:step_size] [-debug] [-no-auto-input] [-no-auto-output]
+                    [-auto-parameter] [-auto-local] [-no-auto-link] [-mt] [-profile] [-sequential] [-dump-json]
 
 Generate FMU from FMU's
 
-optional arguments:
+options:
   -h, -help
   -fmu-directory FMU_DIRECTORY      Directory containing initial FMU’s and used to generate containers. If not defined,
                                     current directory is used. (default: .)
+  -fmi FMI_VERSION                  Define version of FMI to be used for container interface.Only '2' or '3' is
+                                    supported. (default: 2)
   -container filename.{csv|json|ssp},[:step_size]
                                     Description of the container to create. (default: [])
   -debug                            Add lot of useful log during the process. (default: False)
   -no-auto-input                    Create ONLY explicit input. (default: True)
   -no-auto-output                   Create ONLY explicit output. (default: True)
   -auto-parameter                   Expose parameters of the embedded fmu's. (default: False)
+  -auto-local                       Expose local variables of the embedded fmu's. (default: False)
   -no-auto-link                     Create ONLY explicit links. (default: True)
   -mt                               Enable Multi-Threaded mode for the generated container. (default: False)
   -profile                          Enable Profiling mode for the generated container. (default: False)
+  -sequential                       Use sequential mode to schedule embedded fmu's. (default: False)
   -dump-json                        Dump a JSON file for each container. (default: False)
 ```
 

fmu_manipulation_toolbox-1.9rc0/fmu_manipulation_toolbox/__version__.py

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

{fmu_manipulation_toolbox-1.8.4.3b0 → fmu_manipulation_toolbox-1.9rc0}/fmu_manipulation_toolbox/assembly.py

@@ -37,7 +37,7 @@ class Connection:
 
 
 class AssemblyNode:
-    def __init__(self, name: Optional[str], step_size: float = None, mt=False, profiling=False,
+    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):
         self.name = name
         if step_size:
@@ -50,6 +50,7 @@ class AssemblyNode:
             self.step_size = None
         self.mt = mt
         self.profiling = profiling
+        self.sequential = sequential
         self.auto_link = auto_link
         self.auto_input = auto_input
         self.auto_output = auto_output
@@ -138,7 +139,8 @@ class AssemblyNode:
         for link_rule in wired.rule_link:
             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, debug=debug)
+        container.make_fmu(self.name, self.step_size, mt=self.mt, profiling=self.profiling, sequential=self.sequential,
+                           debug=debug)
 
         for node in self.children.values():
             logger.info(f"Deleting transient FMU Container '{node.name}'")
@@ -216,7 +218,7 @@ class AssemblyError(Exception):
 
 
 class Assembly:
-    def __init__(self, filename: str, step_size=None, auto_link=True,  auto_input=True, debug=False,
+    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):
         self.filename = Path(filename)
@@ -228,6 +230,7 @@ class Assembly:
         self.default_auto_parameter = auto_parameter
         self.default_auto_local = auto_local
         self.default_mt = mt
+        self.default_sequential = sequential
         self.default_profiling = profiling
         self.fmu_directory = fmu_directory
         self.transient_filenames: List[Path] = []
@@ -283,8 +286,9 @@ class Assembly:
         name = str(self.filename.with_suffix(".fmu"))
         self.root = AssemblyNode(name, step_size=self.default_step_size, auto_link=self.default_auto_link,
                                  mt=self.default_mt, profiling=self.default_profiling,
-                                 auto_input=self.default_auto_input, auto_output=self.default_auto_output,
-                                 auto_parameter=self.default_auto_parameter, auto_local=self.default_auto_local)
+                                 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)
 
         with open(self.input_pathname) as file:
             reader = csv.reader(file, delimiter=';')
@@ -385,6 +389,7 @@ class Assembly:
         name = data.get("name", None)                                                       # 1
         mt = data.get("mt", self.default_mt)                                                # 2
         profiling = data.get("profiling", self.default_profiling)                           # 3
+        sequential = data.get("sequential", self.default_sequential)                        # 3b
         auto_link = data.get("auto_link", self.default_auto_link)                           # 4
         auto_input = data.get("auto_input", self.default_auto_input)                        # 5
         auto_output = data.get("auto_output", self.default_auto_output)                     # 6
@@ -393,11 +398,12 @@ class Assembly:
         step_size = data.get("step_size", self.default_step_size)                           # 7
 
         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)
 
         for key, value in data.items():
-            if key in ('name', 'step_size', 'auto_link', 'auto_input', 'auto_output', 'mt', 'profiling',
+            if key in ('name', 'step_size', 'auto_link', 'auto_input', 'auto_output', 'mt', 'profiling', 'sequential',
                        'auto_parameter', 'auto_local'):
                 continue  # Already read
 
@@ -455,6 +461,7 @@ class Assembly:
         json_node["name"] = node.name                      # 1
         json_node["mt"] = node.mt                          # 2
         json_node["profiling"] = node.profiling            # 3
+        json_node["sequential"] = node.sequential          # 3b
         json_node["auto_link"] = node.auto_link            # 4
         json_node["auto_input"] = node.auto_input          # 5
         json_node["auto_output"] = node.auto_output        # 6

{fmu_manipulation_toolbox-1.8.4.3b0 → fmu_manipulation_toolbox-1.9rc0}/fmu_manipulation_toolbox/container.py

@@ -16,15 +16,15 @@ logger = logging.getLogger("fmu_manipulation_toolbox")
 
 class FMUPort:
     def __init__(self, attrs: Dict[str, str]):
-        self.causality = attrs.pop("causality", "local")
-        self.variability = attrs.pop("variability", "continuous")
-        self.name = attrs.pop("name")
-        self.vr = int(attrs.pop("valueReference"))
-        self.description = attrs.pop("description", None)
+        self.causality = attrs.get("causality", "local")
+        self.variability = attrs.get("variability", "continuous")
+        self.name = attrs.get("name")
+        self.vr = int(attrs.get("valueReference"))
+        self.description = attrs.get("description", None)
 
-        self.type_name = attrs.pop("type_name", None)
-        self.start_value = attrs.pop("start", None)
-        self.initial = attrs.pop("initial", None)
+        self.type_name = attrs.get("type_name", None)
+        self.start_value = attrs.get("start", None)
+        self.initial = attrs.get("initial", None)
 
     def set_port_type(self, type_name: str, attrs: Dict[str, str]):
         self.type_name = type_name
@@ -465,7 +465,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):
+                 profiling=False, sequential=False):
         if isinstance(fmu_filename, str):
             fmu_filename = Path(fmu_filename)
 
@@ -481,7 +481,7 @@ class FMUContainer:
         with open(base_directory / "modelDescription.xml", "wt") as xml_file:
             self.make_fmu_xml(xml_file, step_size, profiling)
         with open(resources_directory / "container.txt", "wt") as txt_file:
-            self.make_fmu_txt(txt_file, step_size, mt, profiling)
+            self.make_fmu_txt(txt_file, step_size, mt, profiling, sequential)
 
         self.make_fmu_package(base_directory, fmu_filename)
         if not debug:
@@ -594,16 +594,10 @@ class FMUContainer:
 </fmiModelDescription>
 """)
 
-    def make_fmu_txt(self, txt_file, step_size: float, mt: bool, profiling: bool):
-        if mt:
-            print("# Use MT\n1", file=txt_file)
-        else:
-            print("# Don't use MT\n0", file=txt_file)
-
-        if profiling:
-            print("# Profiling ENABLED\n1", file=txt_file)
-        else:
-            print("# Profiling DISABLED\n0", file=txt_file)
+    def make_fmu_txt(self, txt_file, step_size: float, mt: bool, profiling: bool, sequential: bool):
+        print("# Container flags <MT> <Profiling> <Sequential>", file=txt_file)
+        flags = [ str(int(flag == True)) for flag in (mt, profiling, sequential)]
+        print(" ".join(flags), file=txt_file)
 
         print(f"# Internal time step in seconds", file=txt_file)
         print(f"{step_size}", file=txt_file)

{fmu_manipulation_toolbox-1.8.4.3b0 → fmu_manipulation_toolbox-1.9rc0}/fmu_manipulation_toolbox/split.py

@@ -40,6 +40,7 @@ class FMUSplitter:
     def __init__(self, fmu_filename: str):
         self.fmu_filename = Path(fmu_filename)
         self.directory = self.fmu_filename.with_suffix(".dir")
+        self.zip = None # to handle error
         self.zip = zipfile.ZipFile(self.fmu_filename)
         self.filenames_list = self.zip.namelist()
         self.dir_set = self.get_dir_set()
@@ -58,8 +59,9 @@ class FMUSplitter:
         return dir_set
 
     def __del__(self):
-        logger.debug("Closing zip file")
-        self.zip.close()
+        if self.zip is not None:
+            logger.debug("Closing zip file")
+            self.zip.close()
 
     def split_fmu(self):
         logger.info(f"Splitting...")
@@ -178,8 +180,18 @@ class FMUSplitterDescription:
             parser.ParseFile(file)
 
     def parse_txt_file_header(self, file, txt_filename):
-        self.config["mt"] = self.get_line(file) == "1"
-        self.config["profiling"] = self.get_line(file) == "1"
+        flags = self.get_line(file).split(" ")
+        if len(flags) == 1:
+            self.config["mt"] = flags[0] == "1"
+            self.config["profiling"] = self.get_line(file) == "1"
+            self.config["sequential"] = False
+        elif len(flags) == 3:
+            self.config["mt"] = flags[0] == "1"
+            self.config["profiling"] = flags[1] == "1"
+            self.config["sequential"] = flags[2] == "1"
+        else:
+            raise FMUSplitterError(f"Cannot interpret flags '{flags}'")
+
         self.config["step_size"] = float(self.get_line(file))
         nb_fmu = int(self.get_line(file))
         logger.debug(f"Number of FMUs: {nb_fmu}")
@@ -188,10 +200,15 @@ class FMUSplitterDescription:
         for i in range(nb_fmu):
             fmu_filename = self.get_line(file)
             base_directory = "/".join(txt_filename.split("/")[0:-1])
-            try:
-                self.parse_model_description(f"{base_directory}/{fmu_filename}", fmu_filename)
-            except KeyError:
-                self.parse_model_description(f"{base_directory}/{i:02x}", fmu_filename)
+
+            directory = f"{base_directory}/{fmu_filename}"
+            if f"{directory}/modelDescription.xml" not in self.zip.namelist():
+                directory = f"{base_directory}/{i:02x}"
+                if f"{directory}/modelDescription.xml" not in self.zip.namelist():
+                    print(self.zip.namelist())
+                    raise FMUSplitterError(f"Cannot find in FMU directory in {directory}.")
+
+            self.parse_model_description(directory, fmu_filename)
             self.config["candidate_fmu"].append(fmu_filename)
             _library = self.get_line(file)
             _uuid = self.get_line(file)
@@ -241,7 +258,6 @@ class FMUSplitterDescription:
             self.parse_txt_file_header(file, txt_filename)
             self.parse_txt_file_ports(file)
 
-
             for fmu_filename in self.config["candidate_fmu"]:
                 # Inputs per FMUs
                 for fmi_type in ("Real", "Integer", "Boolean", "String"):

{fmu_manipulation_toolbox-1.8.4.3b0 → fmu_manipulation_toolbox-1.9rc0}/fmu_manipulation_toolbox.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fmu_manipulation_toolbox
-Version: 1.8.4.3b0
+Version: 1.9rc0
 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.8.4.3b0 → fmu_manipulation_toolbox-1.9rc0}/tests/test_suite.py

@@ -72,6 +72,16 @@ class FMUManipulationToolboxTestSuite(unittest.TestCase):
         self.assert_identical_files("containers/bouncing_ball/REF-bouncing.json",
                                     "containers/bouncing_ball/bouncing.json")
 
+    def test_container_bouncing_ball_seq(self):
+        assembly = Assembly("bouncing-seq.csv", fmu_directory=Path("containers/bouncing_ball"), mt=True, debug=True,
+                            sequential=True)
+        assembly.write_json("bouncing-seq.json")
+        assembly.make_fmu()
+        self.assert_identical_files("containers/bouncing_ball/REF-container-seq.txt",
+                                    "containers/bouncing_ball/bouncing-seq/resources/container.txt")
+        self.assert_identical_files("containers/bouncing_ball/REF-bouncing-seq.json",
+                                    "containers/bouncing_ball/bouncing-seq.json")
+
     def test_container_bouncing_ball_profiling(self):
         assembly = Assembly("bouncing-profiling.csv", fmu_directory=Path("containers/bouncing_ball"), profiling=True,
                             debug=True)

fmu_manipulation_toolbox-1.8.4.3b0/fmu_manipulation_toolbox/__version__.py

@@ -1 +0,0 @@
-'V1.8.4.3-beta'