Merge pull request #8 from grouperenault/fmu_manipulation_toolbox

Rename project to "FMU Manipulation Toolbox"

Author: tardyp

.github/workflows/fmutool-package.yml .github/workflows/fmu_manipulation_toolbox-package.yml

@@ -1,6 +1,6 @@
 # This starter workflow is for a CMake project running on multiple platforms. There is a different starter workflow if you just want a single platform.
 # See: https://github.com/actions/starter-workflows/blob/main/ci/cmake-single-platform.yml
-name: Release FMUTOOL
+name: Release FMUManipulationToolbox
 
 on:
   push:
@@ -39,7 +39,7 @@ jobs:
         uses: actions/upload-artifact@master
         with:
           name: remoting-win32
-          path: ${{ github.workspace }}/fmutool/resources/win32/
+          path: ${{ github.workspace }}/fmu_manipulation_toolbox/resources/win32/
           retention-days: 1
   remoting-windows64:
     runs-on: windows-latest
@@ -71,7 +71,7 @@ jobs:
         uses: actions/upload-artifact@master
         with:
           name: remoting-win64
-          path: ${{ github.workspace }}/fmutool/resources/win64
+          path: ${{ github.workspace }}/fmu_manipulation_toolbox/resources/win64
           retention-days: 1
   remoting-linux32:
     runs-on: ubuntu-latest
@@ -107,7 +107,7 @@ jobs:
         uses: actions/upload-artifact@master
         with:
           name: remoting-linux32
-          path: ${{ github.workspace }}/fmutool/resources/linux32
+          path: ${{ github.workspace }}/fmu_manipulation_toolbox/resources/linux32
           retention-days: 1
   remoting-linux64:
     runs-on: ubuntu-latest
@@ -138,7 +138,7 @@ jobs:
         uses: actions/upload-artifact@master
         with:
           name: remoting-linux64
-          path: ${{ github.workspace }}/fmutool/resources/linux64
+          path: ${{ github.workspace }}/fmu_manipulation_toolbox/resources/linux64
           retention-days: 1
   container-windows64:
     runs-on: windows-latest
@@ -170,7 +170,7 @@ jobs:
         uses: actions/upload-artifact@master
         with:
           name: container-win64
-          path: ${{ github.workspace }}/fmutool/resources/win64
+          path: ${{ github.workspace }}/fmu_manipulation_toolbox/resources/win64
           retention-days: 1
   container-linux64:
     runs-on: ubuntu-latest
@@ -201,7 +201,7 @@ jobs:
         uses: actions/upload-artifact@master
         with:
           name: container-linux64
-          path: ${{ github.workspace }}/fmutool/resources/linux64
+          path: ${{ github.workspace }}/fmu_manipulation_toolbox/resources/linux64
           retention-days: 1
   package:
     needs: [remoting-windows32, remoting-windows64, remoting-linux32, remoting-linux64, container-windows64, container-linux64]
@@ -211,27 +211,27 @@ jobs:
     - uses: actions/download-artifact@master
       with:
         name: remoting-win64
-        path: ${{ github.workspace }}/fmutool/resources/win64/
+        path: ${{ github.workspace }}/fmu_manipulation_toolbox/resources/win64/
     - uses: actions/download-artifact@master
       with:
         name: remoting-win32
-        path: ${{ github.workspace }}/fmutool/resources/win32/
+        path: ${{ github.workspace }}/fmu_manipulation_toolbox/resources/win32/
     - uses: actions/download-artifact@master
       with:
         name: remoting-linux32
-        path: ${{ github.workspace }}/fmutool/resources/linux32/
+        path: ${{ github.workspace }}/fmu_manipulation_toolbox/resources/linux32/
     - uses: actions/download-artifact@master
       with:
         name: remoting-linux64
-        path: ${{ github.workspace }}/fmutool/resources/linux64/
+        path: ${{ github.workspace }}/fmu_manipulation_toolbox/resources/linux64/
     - uses: actions/download-artifact@master
       with:
         name: container-win64
-        path: ${{ github.workspace }}/fmutool/resources/win64/
+        path: ${{ github.workspace }}/fmu_manipulation_toolbox/resources/win64/
     - uses: actions/download-artifact@master
       with:
         name: container-linux64
-        path: ${{ github.workspace }}/fmutool/resources/linux64/
+        path: ${{ github.workspace }}/fmu_manipulation_toolbox/resources/linux64/
     - name: Set up Python 3.10
       uses: actions/setup-python@v3
       with:

CHANGELOG.md

@@ -46,8 +46,8 @@ if (UNIX AND NOT APPLE)
         target_link_libraries(container Threads::Threads)
 endif()
 set_target_properties(container PROPERTIES
-					  RUNTIME_OUTPUT_DIRECTORY_RELEASE "${CMAKE_CURRENT_SOURCE_DIR}/../fmutool/resources/${FMI_PLATFORM}"
-					  LIBRARY_OUTPUT_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/../fmutool/resources/${FMI_PLATFORM}")
+					  RUNTIME_OUTPUT_DIRECTORY_RELEASE "${CMAKE_CURRENT_SOURCE_DIR}/../fmu_manipulation_toolbox/resources/${FMI_PLATFORM}"
+					  LIBRARY_OUTPUT_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/../fmu_manipulation_toolbox/resources/${FMI_PLATFORM}")
 
  #target_compile_options(container PRIVATE /W4 /WX)
 

README.md

@@ -1,4 +1,4 @@
-from fmutool.fmu_operations import FMU, OperationSaveNamesToCSV, OperationStripTopLevel, \
+from fmu_manipulation_toolbox.fmu_operations import FMU, OperationSaveNamesToCSV, OperationStripTopLevel, \
     OperationRenameFromCSV, OperationAddRemotingWin32, OperationGetNames
 # 1st Use Case: remove toplevel bus (if any)
 fmu = FMU("tests/bouncing_ball.fmu")

container/CMakeLists.txt

@@ -1,7 +1,6 @@
 import importlib.util
 import inspect
 import os
-import glob
 import xmlschema
 from xmlschema.validators.exceptions import XMLSchemaValidationError
 from .fmu_operations import OperationAbstract

doc/README.md

@@ -24,7 +24,7 @@ def format(self, record):
             formatter = logging.Formatter(format_per_level[record.levelno])
             return formatter.format(record)
     init()
-    logger = logging.getLogger("fmutool")
+    logger = logging.getLogger("fmu_manipulation_toolbox")
     handler = logging.StreamHandler(stream=sys.stdout)
     handler.setFormatter(CustomFormatter())
     logger.addHandler(handler)
@@ -46,11 +46,11 @@ def make_wide(formatter, w=120, h=36):
 
 
 def fmutool():
-    print(f"FMUTool version {version}")
+    print(f"FMU Manipulation Toolbox version {version}")
     help_message = Help()
 
     parser = argparse.ArgumentParser(prog='fmutool',
-                                     description="Manipulate a FMU by modifying its 'modelDescription.xml'",
+                                     description="Analyse and Manipulate a FMU by modifying its 'modelDescription.xml'",
                                      formatter_class=make_wide(argparse.HelpFormatter),
                                      add_help=False,
                                      epilog="see: https://github.com/grouperenault/fmutool/blob/main/README.md")

doc/checker.md

@@ -11,7 +11,7 @@
 from .fmu_operations import FMU, OperationAbstract, FMUException
 from .version import __version__ as tool_version
 
-logger = logging.getLogger("fmutool")
+logger = logging.getLogger("fmu_manipulation_toolbox")
 
 
 class FMUPort:

doc/example.py

@@ -142,9 +142,15 @@ def __init__(self):
         self.setFont(font)
         self.setMinimumWidth(800)
         self.setMinimumHeight(480)
+
+        self.insertHtml('<center><img src="fmu_manipulation_toolbox.png"/></center><br>')
         LogWidget.XStream.stdout().messageWritten.connect(self.insertPlainText)
         LogWidget.XStream.stderr().messageWritten.connect(self.insertPlainText)
 
+    def loadResource(self, type, name):
+        image_path = os.path.join(os.path.dirname(__file__), "resources", name.toString())
+        return QPixmap(image_path)
+
 
 class HelpWidget(QLabel):
     HELP_URL = "https://github.com/grouperenault/fmutool/blob/main/README.md"
@@ -202,12 +208,12 @@ def get(self):
             return sorted(self.items_selected)
 
 
-class FmutoolMainWindow(QWidget):
+class FMUManipulationToolboxlMainWindow(QWidget):
     def __init__(self, app, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
-        self.setWindowTitle('FMUTool - manipulate your FMU''s')
-        self.setWindowIcon(QIcon(os.path.join(os.path.dirname(__file__), 'resources', 'fmutool.png')))
+        self.setWindowTitle('FMU Manipulation Toolbox')
+        self.setWindowIcon(QIcon(os.path.join(os.path.dirname(__file__), 'resources', 'icon.png')))
 
         # set the grid layout
         self.layout = QGridLayout()
@@ -429,11 +435,13 @@ def apply_operation(self, operation):
 
 
 class Application:
-    r"""                                  ____   __  ___  __  __ ______             __
-                    \-^-/        / __/  /  |/  / / / / //_  __/ ___  ___   / /
-                    (o o)       / _/   / /|_/ / / /_/ /  / /   / _ \/ _ \ / /
-                ooO--(_)--Ooo- /_/    /_/  /_/  \____/  /_/    \___/\___//_/"""
+    """
+Analyse and modify your FMUs.
+
+Note: modifying the modelDescription.xml can damage your FMU ! Communicating with the FMU-developer and adapting the
+way the FMU is generated, is preferable when possible.
 
+    """
     def __init__(self):
         QDir.addSearchPath('images', os.path.join(os.path.dirname(__file__), "resources"))
         self.app = QApplication(sys.argv)
@@ -472,9 +480,9 @@ def __init__(self):
 """
 
         self.app.setStyleSheet(css_dark)
-        self.window = FmutoolMainWindow(self.app)
+        self.window = FMUManipulationToolboxlMainWindow(self.app)
+        print(" "*80, f"Version {version}")
         print(self.__doc__)
-        print(f"                                                                Version {version}")
         sys.exit(self.app.exec())
 
     def exit(self):

doc/fmutool.png

@@ -2,7 +2,7 @@ FMPy Remoting Binaries License
 ==============================
 
 The 32-bit remoting binaries (binaries/win64/<model_name>.dll and
-binaries/win64/server.exe) are part of FMUTOOL
+binaries/win64/server.exe) are part of FMU Manipulation Toolbox
 and released under the 2-Clause BSD license:
 
 Copyright 2023 Renault SAS

doc/gui.png

@@ -1,7 +1,7 @@
 try:
-    from fmutool.__version__ import __doc__ as __version__
+    from fmu_manipulation_toolbox.__version__ import __doc__ as __version__
 except ModuleNotFoundError:
-    __version__ = "0.0-dev"
+    __version__ = "0.0.dev0"
 
 __author__ = "[email protected]"
 __copyright__ = "Copyright 2023-2024, Renault SAS"