fmu-manipulation-toolbox 1.9rc2__py3-none-any.whl → 1.9rc4__py3-none-any.whl

fmu_manipulation_toolbox/__version__.py

@@ -1 +1 @@
-'V1.9-rc2'
+'V1.9-rc4'

fmu_manipulation_toolbox/container.py

@@ -1,5 +1,6 @@
 import logging
 import getpass
+import math
 import os
 import shutil
 import uuid
@@ -162,7 +163,8 @@ class EmbeddedFMUPort:
 
 class EmbeddedFMU(OperationAbstract):
     capability_list = ("needsExecutionTool",
-                       "canBeInstantiatedOnlyOncePerProcess")
+                       "canBeInstantiatedOnlyOncePerProcess",
+                       "canHandleVariableCommunicationStepSize")
 
     def __init__(self, filename):
         self.fmu = FMU(filename)
@@ -211,7 +213,7 @@ class EmbeddedFMU(OperationAbstract):
         self.ports[port.name] = port
 
     def __repr__(self):
-        return f"FMU '{self.name}' ({len(self.ports)} variables)"
+        return f"FMU '{self.name}' ({len(self.ports)} variables, ts={self.step_size}s)"
 
 
 class FMUContainerError(Exception):
@@ -491,8 +493,8 @@ class FMUContainer:
 
         try:
             fmu = EmbeddedFMU(self.fmu_directory / fmu_filename)
-            if fmu.fmi_version > self.fmi_version:
-                logger.warning(f"Try to embed FMU-{fmu.fmi_version} into container FMI-{self.fmi_version}")
+            if not fmu.fmi_version == self.fmi_version:
+                logger.warning(f"Try to embed FMU-{fmu.fmi_version} into container FMI-{self.fmi_version}.")
             self.involved_fmu[fmu.name] = fmu
 
             logger.debug(f"Adding FMU #{len(self.involved_fmu)}: {fmu}")
@@ -642,16 +644,16 @@ class FMUContainer:
 
         return auto_wired
 
-    def minimum_step_size(self) -> float:
-        step_size = None
+    def default_step_size(self) -> float:
+        freq_set = set()
         for fmu in self.involved_fmu.values():
-            if step_size:
-                if fmu.step_size and fmu.step_size < step_size:
-                    step_size = fmu.step_size
-            else:
-                step_size = fmu.step_size
+            if fmu.step_size and fmu.capabilities["canHandleVariableCommunicationStepSize"] == "false":
+                freq_set.add(int(1.0/fmu.step_size))
 
-        if not step_size:
+        common_freq = math.gcd(*freq_set)
+        try:
+            step_size = 1.0 / float(common_freq)
+        except ZeroDivisionError:
             step_size = 0.1
             logger.warning(f"Defaulting to step_size={step_size}")
 
@@ -659,15 +661,15 @@ class FMUContainer:
 
     def sanity_check(self, step_size: Optional[float]):
         for fmu in self.involved_fmu.values():
-            if not fmu.step_size:
-                continue
-            ts_ratio = step_size / fmu.step_size
-            if ts_ratio < 1.0:
-                logger.warning(f"Container step_size={step_size}s is lower than FMU '{fmu.name}' "
-                               f"step_size={fmu.step_size}s.")
-            if ts_ratio != int(ts_ratio):
-                logger.warning(f"Container step_size={step_size}s should divisible by FMU '{fmu.name}' "
-                               f"step_size={fmu.step_size}s.")
+            if fmu.step_size and fmu.capabilities["canHandleVariableCommunicationStepSize"] == "false":
+                ts_ratio = step_size / fmu.step_size
+                logger.debug(f"container step_size: {step_size} = {fmu.step_size} x {ts_ratio} for {fmu.name}")
+                if ts_ratio < 1.0:
+                    logger.warning(f"Container step_size={step_size}s is lower than FMU '{fmu.name}' "
+                                   f"step_size={fmu.step_size}s.")
+                if ts_ratio != int(ts_ratio):
+                    logger.warning(f"Container step_size={step_size}s should divisible by FMU '{fmu.name}' "
+                                   f"step_size={fmu.step_size}s.")
             for port_name in fmu.ports:
                 cport = ContainerPort(fmu, port_name)
                 if cport not in self.rules:
@@ -683,7 +685,7 @@ class FMUContainer:
 
         if step_size is None:
             logger.info(f"step_size  will be deduced from the embedded FMU's")
-            step_size = self.minimum_step_size()
+            step_size = self.default_step_size()
         self.sanity_check(step_size)
 
         logger.info(f"Building FMU '{fmu_filename}', step_size={step_size}")

fmu_manipulation_toolbox/gui.py

@@ -13,6 +13,8 @@ from functools import partial
 
 from .gui_style import gui_style, log_color
 from .operations import *
+from .remoting import (OperationAddRemotingWin32, OperationAddRemotingWin64, OperationAddFrontendWin32,
+                       OperationAddFrontendWin64)
 from .assembly import Assembly, AssemblyNode
 from .checker import checker_list
 from .help import Help

fmu_manipulation_toolbox/operations.py

@@ -8,7 +8,6 @@ import tempfile
 import xml.parsers.expat
 import zipfile
 import hashlib
-from pathlib import Path
 from typing import *
 
 logger = logging.getLogger("fmu_manipulation_toolbox")
@@ -279,7 +278,7 @@ class OperationAbstract:
     def experiment_attrs(self, attrs):
         pass
 
-    def port_attrs(self, fmu_port) -> int:
+    def port_attrs(self, fmu_port: FMUPort) -> int:
         """ return 0 to keep port, otherwise remove it"""
         return 0
 
@@ -366,65 +365,6 @@ class OperationRenameFromCSV(OperationAbstract):
             return 1
 
 
-class OperationAddRemotingWinAbstract(OperationAbstract):
-    bitness_from = None
-    bitness_to = None
-
-    def __repr__(self):
-        return f"Add '{self.bitness_to}' remoting on '{self.bitness_from}' FMU"
-
-    def fmi_attrs(self, attrs):
-        if not attrs["fmiVersion"] == "2.0":
-            raise OperationError(f"Adding remoting is only available for FMI-2.0")
-
-    def cosimulation_attrs(self, attrs):
-        fmu_bin = {
-            "win32":  os.path.join(self.fmu.tmp_directory, "binaries", f"win32"),
-            "win64": os.path.join(self.fmu.tmp_directory, "binaries", f"win64"),
-        }
-
-        if not os.path.isdir(fmu_bin[self.bitness_from]):
-            raise OperationError(f"{self.bitness_from} interface does not exist")
-
-        if os.path.isdir(fmu_bin[self.bitness_to]):
-            logger.info(f"{self.bitness_to} already exists. Add front-end.")
-            shutil.move(os.path.join(fmu_bin[self.bitness_to], attrs['modelIdentifier'] + ".dll"),
-                        os.path.join(fmu_bin[self.bitness_to], attrs['modelIdentifier'] + "-remoted.dll"))
-        else:
-            os.mkdir(fmu_bin[self.bitness_to])
-
-        to_path = Path(__file__).parent / "resources" / self.bitness_to
-        shutil.copyfile(to_path / "client_sm.dll",
-                        Path(fmu_bin[self.bitness_to]) / Path(attrs['modelIdentifier']).with_suffix(".dll"))
-
-        from_path = Path(__file__).parent / "resources" / self.bitness_from
-        shutil.copyfile(from_path / "server_sm.exe",
-                        Path(fmu_bin[self.bitness_from]) / "server_sm.exe")
-
-        shutil.copyfile(Path(__file__).parent / "resources" / "license.txt",
-                        Path(fmu_bin[self.bitness_to]) / "license.txt")
-
-
-class OperationAddRemotingWin64(OperationAddRemotingWinAbstract):
-    bitness_from = "win32"
-    bitness_to = "win64"
-
-
-class OperationAddFrontendWin32(OperationAddRemotingWinAbstract):
-    bitness_from = "win32"
-    bitness_to = "win32"
-
-
-class OperationAddFrontendWin64(OperationAddRemotingWinAbstract):
-    bitness_from = "win64"
-    bitness_to = "win64"
-
-
-class OperationAddRemotingWin32(OperationAddRemotingWinAbstract):
-    bitness_from = "win64"
-    bitness_to = "win32"
-
-
 class OperationRemoveRegexp(OperationAbstract):
     def __repr__(self):
         return f"Remove ports matching '{self.regex_string}'"

fmu_manipulation_toolbox/remoting.py

@@ -0,0 +1,105 @@
+import logging
+import shutil
+
+from pathlib import Path
+from .operations import OperationAbstract, OperationError
+
+logger = logging.getLogger("fmu_manipulation_toolbox")
+
+class OperationAddRemotingWinAbstract(OperationAbstract):
+    bitness_from = None
+    bitness_to = None
+
+    def __repr__(self):
+        return f"Add '{self.bitness_to}' remoting on '{self.bitness_from}' FMU"
+
+    def __init__(self):
+        self.vr = {
+            "Real": [],
+            "Integer": [],
+            "Boolean": []
+        }
+        self.nb_input = 0;
+        self.nb_output = 0;
+
+    def fmi_attrs(self, attrs):
+        if not attrs["fmiVersion"] == "2.0":
+            raise OperationError(f"Adding remoting is only available for FMI-2.0")
+
+    def cosimulation_attrs(self, attrs):
+        fmu_bin = {
+            "win32": Path(self.fmu.tmp_directory) / "binaries" / "win32",
+            "win64": Path(self.fmu.tmp_directory) / "binaries" / "win64",
+        }
+
+        if not fmu_bin[self.bitness_from].is_dir():
+            raise OperationError(f"{self.bitness_from} interface does not exist")
+
+        if fmu_bin[self.bitness_to].is_dir():
+            logger.info(f"{self.bitness_to} already exists. Add front-end.")
+            shutil.move(fmu_bin[self.bitness_to] / Path(attrs['modelIdentifier']).with_suffix(".dll"),
+                        fmu_bin[self.bitness_to] / Path(attrs['modelIdentifier']).with_suffix("-remoted.dll"))
+        else:
+            fmu_bin[self.bitness_to].mkdir()
+
+        to_path = Path(__file__).parent / "resources" / self.bitness_to
+        try:
+            shutil.copyfile(to_path / "client_sm.dll",
+                            fmu_bin[self.bitness_to] / Path(attrs['modelIdentifier']).with_suffix(".dll"))
+        except FileNotFoundError as e:
+            logger.critical(f"Cannot add remoting client: {e}")
+
+        from_path = Path(__file__).parent / "resources" / self.bitness_from
+        try:
+            shutil.copyfile(from_path / "server_sm.exe",
+                            fmu_bin[self.bitness_from] / "server_sm.exe")
+        except FileNotFoundError as e:
+            logger.critical(f"Cannot add remoting server: {e}")
+
+        shutil.copyfile(Path(__file__).parent / "resources" / "license.txt",
+                        fmu_bin[self.bitness_to] / "license.txt")
+
+    def port_attrs(self, fmu_port) -> int:
+        try:
+            self.vr[fmu_port.fmi_type].append(fmu_port["valueReference"])
+            if fmu_port["causality"] in ("input", "parameter"):
+                self.nb_input += 1
+            else:
+                self.nb_output += 1
+        except KeyError:
+            logger.error(f"Type '{fmu_port.fmi_type}' is not supported by remoting.")
+
+        return 0
+
+    def closure(self):
+        target_dir = Path(self.fmu.tmp_directory) / "resources"
+        if not target_dir.is_dir():
+            target_dir.mkdir()
+
+        logger.info(f"Remoting nb input port: {self.nb_input}")
+        logger.info(f"Remoting nb output port: {self.nb_output}")
+        with open(target_dir/ "remoting_table.txt", "wt") as file:
+            for fmi_type in ('Real', 'Integer', 'Boolean'):
+                print(len(self.vr[fmi_type]), file=file)
+            for fmi_type in ('Real', 'Integer', 'Boolean'):
+                for vr in sorted(self.vr[fmi_type]):
+                    print(vr, file=file)
+
+class OperationAddRemotingWin64(OperationAddRemotingWinAbstract):
+    bitness_from = "win32"
+    bitness_to = "win64"
+
+
+class OperationAddFrontendWin32(OperationAddRemotingWinAbstract):
+    bitness_from = "win32"
+    bitness_to = "win32"
+
+
+class OperationAddFrontendWin64(OperationAddRemotingWinAbstract):
+    bitness_from = "win64"
+    bitness_to = "win64"
+
+
+class OperationAddRemotingWin32(OperationAddRemotingWinAbstract):
+    bitness_from = "win64"
+    bitness_to = "win32"

{fmu_manipulation_toolbox-1.9rc2.dist-info → fmu_manipulation_toolbox-1.9rc4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fmu_manipulation_toolbox
-Version: 1.9rc2
+Version: 1.9rc4
 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.9rc2.dist-info → fmu_manipulation_toolbox-1.9rc4.dist-info}/RECORD

@@ -1,13 +1,14 @@
 fmu_manipulation_toolbox/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 fmu_manipulation_toolbox/__main__.py,sha256=FpG0ITBz5q-AvIbXplVh_1g1zla5souFGtpiDdECxEw,352
-fmu_manipulation_toolbox/__version__.py,sha256=Z-9JT4Rjt43p25I55xHJame93p0nfRXYoSRRq-Je6wY,11
+fmu_manipulation_toolbox/__version__.py,sha256=MQjjcF80yR4bZlt37VLxEd4f1ULWsh44GbAtNZuRqCo,11
 fmu_manipulation_toolbox/assembly.py,sha256=XQ_1sB6K1Dk2mnNe-E3_6Opoeub7F9Qaln0EUDzsop8,26553
 fmu_manipulation_toolbox/checker.py,sha256=jw1omfrMMIMHlIpHXpWBcQgIiS9hnHe5T9CZ5KlbVGs,2422
-fmu_manipulation_toolbox/container.py,sha256=8Wf16sgUPkY-ByWeKt-3TD_4vNRQuLwH9Gs7D2Q6tAk,44959
-fmu_manipulation_toolbox/gui.py,sha256=iOJ3F_zfw3mU34VofZrYdaffljTmYfuy33fJXlLaOwg,29045
+fmu_manipulation_toolbox/container.py,sha256=SDP3RjiHCqAtRDU2uZl1slbsxWAR5v_uAcegeNxzwQc,45322
+fmu_manipulation_toolbox/gui.py,sha256=ax-IbGO7GyBG0Mb5okN588CKQDfMxoF1uZtD1_CYnjc,29199
 fmu_manipulation_toolbox/gui_style.py,sha256=s6WdrnNd_lCMWhuBf5LKK8wrfLXCU7pFTLUfvqkJVno,6633
 fmu_manipulation_toolbox/help.py,sha256=aklKiLrsE0adSzQ5uoEB1sBDmI6s4l231gavu4XxxzA,5856
-fmu_manipulation_toolbox/operations.py,sha256=b7N5AVHLIpQO8od4BYasb9CppHJ-ZmW8mu0ZdhndoHI,19472
+fmu_manipulation_toolbox/operations.py,sha256=4n4Tn5QO6k3560OZgjnRw_V0me6xOy9TbmKDeoIUbT0,17242
+fmu_manipulation_toolbox/remoting.py,sha256=vsvGRIUr-VxUkpBMCfE_G0kYVnB2CN03ts_Imi2uLk8,3814
 fmu_manipulation_toolbox/split.py,sha256=NVkfdTRR0jj_VOdgtxHQoKptkAg5TFVUA7nUx3_o9Pg,13336
 fmu_manipulation_toolbox/version.py,sha256=OhBLkZ1-nhC77kyvffPNAf6m8OZe1bYTnNf_PWs1NvM,392
 fmu_manipulation_toolbox/resources/checkbox-checked-disabled.png,sha256=FWIuyrXlaNLLePHfXj7j9ca5rT8Hgr14KCe1EqTCZyk,2288
@@ -27,7 +28,7 @@ fmu_manipulation_toolbox/resources/icon_fmu.png,sha256=EuygB2xcoM2WAfKKdyKG_UvTL
 fmu_manipulation_toolbox/resources/license.txt,sha256=5ODuU8g8pIkK-NMWXu_rjZ6k7gM7b-N2rmg87-2Kmqw,1583
 fmu_manipulation_toolbox/resources/mask.png,sha256=px1U4hQGL0AmZ4BQPknOVREpMpTSejbah3ntkpqAzFA,3008
 fmu_manipulation_toolbox/resources/model.png,sha256=EAf_HnZJe8zYGZygerG1MMt2U-tMMZlifzXPj4_iORA,208788
-fmu_manipulation_toolbox/resources/darwin64/container.dylib,sha256=G6ABYe2mBmI_0pGU6HJly3yhKh6VEirgN4RFAThUES4,161496
+fmu_manipulation_toolbox/resources/darwin64/container.dylib,sha256=aXVIpGx6OYxHEqw9R4V7IjM5KVjQTEFEG4sFpPsIFG0,161560
 fmu_manipulation_toolbox/resources/fmi-2.0/fmi2Annotation.xsd,sha256=OGfyJtaJntKypX5KDpuZ-nV1oYLZ6HV16pkpKOmYox4,2731
 fmu_manipulation_toolbox/resources/fmi-2.0/fmi2AttributeGroups.xsd,sha256=HwyV7LBse-PQSv4z1xjmtzPU3Hjnv4mluq9YdSBNHMQ,3704
 fmu_manipulation_toolbox/resources/fmi-2.0/fmi2ModelDescription.xsd,sha256=JM4j_9q-pc40XYHb28jfT3iV3aYM5JLqD5aRjO72K1E,18939
@@ -47,19 +48,19 @@ fmu_manipulation_toolbox/resources/fmi-3.0/fmi3Type.xsd,sha256=TaHRoUBIFtmdEwBKB
 fmu_manipulation_toolbox/resources/fmi-3.0/fmi3Unit.xsd,sha256=CK_F2t5LfyQ6eSNJ8soTFMVK9DU8vD2WiMi2MQvjB0g,3746
 fmu_manipulation_toolbox/resources/fmi-3.0/fmi3Variable.xsd,sha256=3YU-3q1-c-namz7sMe5cxnmOVOJsRSmfWR02PKv3xaU,19171
 fmu_manipulation_toolbox/resources/fmi-3.0/fmi3VariableDependency.xsd,sha256=YQSBwXt4IsDlyegY8bX-qQHGSfE5TipTPfo2g2yqq1c,3082
-fmu_manipulation_toolbox/resources/linux32/client_sm.so,sha256=xVdY2zy13pa2DcvFiweSNpp7E6DiONqeoBdlcJHrW_k,35940
-fmu_manipulation_toolbox/resources/linux32/server_sm,sha256=1TLGqNPyM5UVOrCfzNqWyF6ClLksY3EiY3CSsrnp6c0,22836
-fmu_manipulation_toolbox/resources/linux64/client_sm.so,sha256=EhY1XHo1YcQn6yqZ7wk5okqtZyp0MrcCsGcudqE-aIM,37000
-fmu_manipulation_toolbox/resources/linux64/container.so,sha256=KtvL1rmCFE6FA2mFGoHEhIYqAYd47ZmJLK5YsyO7TqM,135464
-fmu_manipulation_toolbox/resources/linux64/server_sm,sha256=ulfoPvmaYe9nInYcVEyj7mD9zDzGk56OUoWx1mPKLiE,22768
-fmu_manipulation_toolbox/resources/win32/client_sm.dll,sha256=rL9OCeoOmCvzf88mFubyPvTDImKxO26fNHoX5a_wuaI,17920
-fmu_manipulation_toolbox/resources/win32/server_sm.exe,sha256=NGBZkTqSBFg8Wja_BYqoumk6qKmQoND4n8tDcPvKj8g,15872
-fmu_manipulation_toolbox/resources/win64/client_sm.dll,sha256=UZi61eVctdZ0jLEsC5GWAG4zM6LTq6firPYNByz39LQ,22016
-fmu_manipulation_toolbox/resources/win64/container.dll,sha256=6-HLcAhtd68PMD0SVloSrfpFJlUdSJLp58hqjzCLsHQ,97792
-fmu_manipulation_toolbox/resources/win64/server_sm.exe,sha256=wWZuT98XkCraZNNlWsnxoxoYABsXiJbxVDXg5zirnjI,19968
-fmu_manipulation_toolbox-1.9rc2.dist-info/licenses/LICENSE.txt,sha256=c_862mzyk6ownO3Gt6cVs0-53IXLi_-ZEQFNDVabESw,1285
-fmu_manipulation_toolbox-1.9rc2.dist-info/METADATA,sha256=CAh7QGHMed2PqNbtoLGwhn46FEwESV4uXEMaAPIPkJY,1156
-fmu_manipulation_toolbox-1.9rc2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-fmu_manipulation_toolbox-1.9rc2.dist-info/entry_points.txt,sha256=HjOZkflbI1IuSY8BpOZre20m24M4GDQGCJfPIa7NrlY,264
-fmu_manipulation_toolbox-1.9rc2.dist-info/top_level.txt,sha256=9D_h-5BMjSqf9z-XFkbJL_bMppR2XNYW3WNuPkXou0k,25
-fmu_manipulation_toolbox-1.9rc2.dist-info/RECORD,,
+fmu_manipulation_toolbox/resources/linux32/client_sm.so,sha256=ytv2fMHRYkQS4v_ODKVCt3Z_19k7tCYTKT8kKOK0Pu0,34756
+fmu_manipulation_toolbox/resources/linux32/server_sm,sha256=pHXd5rRyJrCEUPGxVcK3irE86ThxVUTBRn_rgOZdSYg,21224
+fmu_manipulation_toolbox/resources/linux64/client_sm.so,sha256=xBgQTTiww_SON8bHP4UP6UT8PqzzHiBgJHTiiG3Asi8,32592
+fmu_manipulation_toolbox/resources/linux64/container.so,sha256=rgaCBItfw-ehwnqvf4sfN6GPbVffw7mKBNcfUeTmWlE,135520
+fmu_manipulation_toolbox/resources/linux64/server_sm,sha256=A6-IQUCN51r5rQkEW9lJJuZKqRPgeoxyMwjc5NNMq-A,22552
+fmu_manipulation_toolbox/resources/win32/client_sm.dll,sha256=8pAVogHR9XYTroHEtHaXbZX9pcB_FqMYw64m5BPcVrA,17408
+fmu_manipulation_toolbox/resources/win32/server_sm.exe,sha256=AENRfy4kw9F6swsyDjfSuISWcVmdTiMUPbiLwPy1_1E,15360
+fmu_manipulation_toolbox/resources/win64/client_sm.dll,sha256=T0RskNAJ66BZUkj_GDO0ECdPl_KrGrpHrpwUAjWRONk,20992
+fmu_manipulation_toolbox/resources/win64/container.dll,sha256=nyBejwuIkWmF90XgxYx0S9QVoTOXigW_6oottiC_R5s,98816
+fmu_manipulation_toolbox/resources/win64/server_sm.exe,sha256=W73zt3R0aquuPswUD0ymQ5_n0lQEkZ93MB6v88uZ_M8,18432
+fmu_manipulation_toolbox-1.9rc4.dist-info/licenses/LICENSE.txt,sha256=c_862mzyk6ownO3Gt6cVs0-53IXLi_-ZEQFNDVabESw,1285
+fmu_manipulation_toolbox-1.9rc4.dist-info/METADATA,sha256=rTPWWcY4E_TfwlGiT20glhk-OUF6dljaDE_4eaknux0,1156
+fmu_manipulation_toolbox-1.9rc4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+fmu_manipulation_toolbox-1.9rc4.dist-info/entry_points.txt,sha256=HjOZkflbI1IuSY8BpOZre20m24M4GDQGCJfPIa7NrlY,264
+fmu_manipulation_toolbox-1.9rc4.dist-info/top_level.txt,sha256=9D_h-5BMjSqf9z-XFkbJL_bMppR2XNYW3WNuPkXou0k,25
+fmu_manipulation_toolbox-1.9rc4.dist-info/RECORD,,