Add support for Windows (#23)

* Fix no artifacts where needed in CI [skip ci]

* Added Windows CI

* Use environment file for Modelica

* Specify libraries in CI

* Use latest PyDelica version and use context manager for junk cleanup

* Try apt installing om libs

* Use OM Docker image

* Do not use Sudo

* run apt update

* Bump version number

* Update citation file [skip ci]

* Updated changelog [skip ci]

Author: kzscisoft

.github/workflows/build_run.yml .github/workflows/build_run_linux.yml

@@ -1,7 +1,9 @@
-name: Power Balance Models
+name: Power Balance Models Ubuntu
 on: [push]
 jobs:
   test_modelica_build:
+    container:
+      image: openmodelica/openmodelica:v1.18.0-minimal
     name: Test Modelica Build (${{ matrix.os }})
     runs-on: ${{ matrix.os }}
     strategy:
@@ -10,9 +12,8 @@ jobs:
         os: [ubuntu-latest]
     steps:
       - uses: actions/checkout@v2
-      - uses: artemis-beta/setup-openmodelica@v2
-        with:
-          msl-version: '3.2.3'
+      - name: Install OpenModelica libraries
+        run: apt update && apt -y install omlib-modelica-3.2.3 omlib-modelicaservices-3.2.3 omlib-complex-3.2.3
       - name: Compile models
         run: |
           mkdir build
@@ -54,6 +55,8 @@ jobs:
           path: power_balance/profiles/mat_profile_files/*.mat
           retention-days: 1
   model_run_om:
+    container:
+      image: openmodelica/openmodelica:v1.18.0-minimal
     name: Model Run Open Modelica (${{ matrix.os }})
     runs-on: ${{ matrix.os }}
     strategy:
@@ -72,14 +75,15 @@ jobs:
         with:
           name: om-plasma-profiles
           path: power_balance/profiles/mat_profile_files
-      - uses: artemis-beta/setup-openmodelica@v2
-        with:
-          msl-version: '3.2.3'
+      - name: Install OpenModelica libraries
+        run: apt update && apt -y install omlib-modelica-3.2.3 omlib-modelicaservices-3.2.3 omlib-complex-3.2.3
       - name: Run Models
         run: |
           cd build
           for i in $(ls -I "*.h" -I "*.c" -I "*.o" -I "*.json" -I "*.xml" -I "*.makefile" -I "*.mat"); do echo "Running model $i"; chmod +x ./$i; ./$i; done
   model_run_api:
+    container:
+      image: openmodelica/openmodelica:v1.18.0-minimal
     name: Model Run API (${{ matrix.os }} Python${{ matrix.python-version }})
     runs-on: ${{ matrix.os }}
     strategy:
@@ -96,9 +100,8 @@ jobs:
           python-version: ${{ matrix.python-version }}
           architecture: x64
       - uses: Gr1N/setup-poetry@v7
-      - uses: artemis-beta/setup-openmodelica@v2
-        with:
-          msl-version: '3.2.3'
+      - name: Install OpenModelica libraries
+        run: apt update && apt -y install omlib-modelica-3.2.3 omlib-modelicaservices-3.2.3 omlib-complex-3.2.3
       - name: Run Models
         run: |
           poetry install
@@ -111,6 +114,8 @@ jobs:
           path: coverage_default
           retention-days: 1
   regression_tests:
+    container:
+      image: openmodelica/openmodelica:v1.18.0-minimal
     name: Regression Tests (${{ matrix.os }} Python${{ matrix.python-version }})
     runs-on: ${{ matrix.os }}
     strategy:
@@ -127,9 +132,8 @@ jobs:
           python-version: ${{ matrix.python-version }}
           architecture: x64
       - uses: Gr1N/setup-poetry@v7
-      - uses: artemis-beta/setup-openmodelica@v2
-        with:
-          msl-version: '3.2.3'
+      - name: Install OpenModelica libraries
+        run: apt update && apt -y install omlib-modelica-3.2.3 omlib-modelicaservices-3.2.3 omlib-complex-3.2.3
       - name: Run Regression Tests
         run: |
           poetry install
@@ -142,6 +146,8 @@ jobs:
           path: coverage_regression
           retention-days: 1
   unit_tests:
+    container:
+      image: openmodelica/openmodelica:v1.18.0-minimal
     name: Unit Tests (${{ matrix.os }} Python${{ matrix.python-version }})
     runs-on: ${{ matrix.os }}
     strategy:
@@ -158,9 +164,8 @@ jobs:
           python-version: ${{ matrix.python-version }}
           architecture: x64
       - uses: Gr1N/setup-poetry@v7
-      - uses: artemis-beta/setup-openmodelica@v2
-        with:
-          msl-version: '3.2.3'
+      - name: Install OpenModelica libraries
+        run: apt update && apt -y install omlib-modelica-3.2.3 omlib-modelicaservices-3.2.3 omlib-complex-3.2.3
       - name: Run Unit Tests
         run: |
           poetry install

.github/workflows/site_build_and_benchmarks_main.yml

@@ -2,6 +2,8 @@ name: Benchmarks and Docs
 on: [push]
 jobs:
   run_benchmarks:
+    container:
+      image: openmodelica/openmodelica:v1.18.0-minimal
     runs-on: ubuntu-latest
     name: Run Benchmarks on main
     if: ${{ github.ref_name == 'main' }}
@@ -10,16 +12,15 @@ jobs:
       uses: actions/checkout@v2
       with:
         fetch-depth: 0
+    - name: Install OpenModelica libraries
+      run: apt -y install omlib-modelica-3.2.3 omlib-modelicaservices-3.2.3 omlib-complex-3.2.3
     - name: Configure Git credentials
       uses: OleksiyRudenko/gha-git-credentials@v2
       with:
         email: [email protected]
         token: '${{ secrets.GITHUB_TOKEN }}'
     - name: Set up Python
       uses: actions/setup-python@v2
-    - uses: artemis-beta/setup-openmodelica@v2
-      with:
-        msl-version: '3.2.3'
     - name: Setup ASV
       run: |
         python -m pip install asv virtualenv click

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## v1.1.0 - 2022-03-09
+
+* Added support for Windows.
+* Use context manager to ensure removal of temporary files.
+* Compatible with PyDelica v0.4.2
+
 ## v1.0.0 - 2022-02-09
 
 * First full version of Power Balance ready for open sourcing.
@@ -62,4 +68,4 @@
 
 ## pre-api - 2021-01-13
 
-* Creation of `Tokamak.Interdependencies` Modelica model with components for Magnets, Cryogenics and Detritation.
+* Creation of `Tokamak.Interdependencies` Modelica model with components for Magnets, Cryogenics and Detritation.

CITATION.cff

@@ -67,7 +67,7 @@ authors:
     given-names: Timothy
 
 cff-version: "1.2.0"
-date-released: "2022-03-01"
+date-released: "2022-03-09"
 keywords: 
   - "power balance"
   - fusion
@@ -76,8 +76,8 @@ keywords:
 license: LGPL-2.1+
 message: "If you use this software, please cite it using these metadata."
 title: "Power Balance Models"
-commit: "469eaa5570cdc53a0ed91d3af4ce13e7061b2484"
-version: "1.0.1"
+commit: "56067cf8297e90689484fc7c6429880e788c534c"
+version: "1.1.0"
 repository-code: "https://github.com/ukaea/powerbalance"
 url: "https://ukaea.github.io/powerbalance/"
 references:
@@ -163,4 +163,3 @@ references:
     authors:
      - given-names: "John D."
        family-names: "Hunter"
-

benchmarks/bench_models.py

@@ -6,6 +6,8 @@
 
 import pydelica
 
+from power_balance.environment import MODELICA_ENVIRONMENT
+
 MODELS_DIR = os.path.join(pathlib.Path(__file__).parents[1], "power_balance", "models")
 
 MODELS = [
@@ -32,11 +34,14 @@ class ModelBuild:
 
     def setup(self, model):
         self.session = pydelica.Session()
-        self.session.use_library("Modelica", "3.2.3")
+        self.session.use_libraries(MODELICA_ENVIRONMENT)
 
     def time_model_build(self, model):
         _model_path = os.path.join(MODELS_DIR, f"{model.split('.')[0]}.mo")
         if "Tokamak" in model:
             self.session.build_model(_model_path, model, extra_models=MODELS)
         else:
             self.session.build_model(_model_path, model)
+
+    def teardown(self, model):
+        self.session._compiler.clear_cache()

docs/API/advanced_api.md

@@ -38,13 +38,17 @@ Out[6]:
  'tokamak.interdependencies.ratiotype',
  'tokamak.interdependencies.systempressure',
  ...
+In [7]: p.clear_cache()
 ```
 
 !!! warning "Parameter setting"
     All parameters including those that are protected are listed via `PowerBalance.get_parameters()` for
     the purposes of inspection. Only modifiable parameters can be updated, these are listed by running `PowerBalance.modifiable_parameters()`.
 
-
+!!! warning "PyDelica cache"
+    On Windows temporary directories are not deleted on log out. PyDelica uses these to perform builds and store
+    the model binaries. It is therefore recommended unless using `PowerBalance` as a context manager you should
+    run the `clear_cache` method to wipe these build folders upon completion.
 
 
 

docs/API/getting_started.md

@@ -49,18 +49,19 @@ print(data_frame)
 data frames are very powerful objects, you can apply cuts to them and perform operations on subsets, see the [Pandas documentation](https://pandas.pydata.org/docs/) for details.
 
 ## Creating your own scripts
-The main class used to initialise and run a simulation via the OpenModelica backend within PBM is the `PowerBalance` class.
+The main class used to initialise and run a simulation via the OpenModelica backend within PBM is the `PowerBalance` class. It is recommended that the class be used via a context manager to ensure that model build directories are removed upon completion (this is done automatically when using the CLI).
 
 ```python
 from power_balance.core import PowerBalance
 
 # Initialise the PBM class fetching parameters
 # and models from the default locations
-pbm_instance = PowerBalance()
+# Use context manager to ensure junk collection
+with PowerBalance() as pbm_instance:
 
-# Run the simulation with the configuration
-pbm_instance.run_simulation()
+    # Run the simulation with the configuration
+    pbm_instance.run_simulation()
 
-# Open the plots in the browser window
-pbm_instance.launch_browser()
+    # Open the plots in the browser window
+    pbm_instance.launch_browser()
 ```

poetry.lock

@@ -66,18 +66,18 @@ def pbm_main(
     if _args["from_session"]:
         _check_session_directories(_args)
 
-    pbm_instance = pbm_core.PowerBalance(
+    with pbm_core.PowerBalance(
         config=_args["config"],
         no_browser=_args["no_browser"],
         parameter_directory=_args["param_dir"],
         profiles_directory=_args["profiles_dir"],
         modelica_file_dir=_args["model_dir"],
         print_intro=True,
-    )
-    pbm_instance.run_simulation(_args["outputdir"])
+    ) as pbm_instance:
+        pbm_instance.run_simulation(_args["outputdir"])
 
-    if not no_browser:
-        pbm_instance.launch_browser()
+        if not no_browser:
+            pbm_instance.launch_browser()
 
 
 def _check_session_directories(_args):

power_balance/cli/session.py

@@ -24,7 +24,6 @@
 import itertools
 import logging
 import os
-import platform
 import re
 import shutil
 import subprocess
@@ -41,6 +40,7 @@
 import power_balance
 import power_balance.browser as pbm_browser
 import power_balance.configs as pbm_config
+import power_balance.environment as pbm_env
 import power_balance.exceptions as pbm_exc
 import power_balance.modelica_templating.pfmagnets as pbm_pfmagnet_templates
 import power_balance.models as pbm_models
@@ -157,15 +157,7 @@ def __init__(
         self.power_data: typing.Dict[str, pd.DataFrame] = {}
         self.pydelica_session = pydelica.Session(_pde_ll)
 
-        # PBM only compatible with MSL 3.2.3 at present but library switch
-        # only works with UNIX based OSes
-        if platform.system() != "Windows":
-            self.pydelica_session.use_library("Modelica", "3.2.3")
-        else:
-            self._logger.warning(
-                "Cannot set MSL version explicitly on Windows, "
-                "assuming MSL is version 3.2.3"
-            )
+        self.pydelica_session.use_libraries(pbm_env.MODELICA_ENVIRONMENT)
 
         self.configuration = pbm_config.read_options_from_config(config)
 
@@ -227,6 +219,21 @@ def __init__(
         self._check_for_model_mods()
         self.read_models_from_directory()
 
+    def clear_cache(self) -> None:
+        """Clear the PyDelica session cache
+
+        As we do not use pydelica.Session as a context manager we need to do
+        the cache clear manually (else risking leaving a lot of temporary
+        directories on Windows)
+        """
+        self.pydelica_session._compiler.clear_cache()
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, *args, **kwargs):
+        self.clear_cache()
+
     def _deduce_profile_max_values(self) -> typing.Dict[str, float]:
         """
         For the current parameter set deduce the maximum values for profiles

power_balance/core.py

@@ -0,0 +1,7 @@
+import os.path
+
+import toml
+
+MODELICA_ENVIRONMENT = toml.load(
+    open(os.path.join(os.path.dirname(__file__), "modelica.toml"))
+).values()

power_balance/environment/__init__.py

@@ -0,0 +1,11 @@
+[Modelica]
+version="3.2.3"
+name="Modelica"
+
+[ModelicaServices]
+version="3.2.3"
+name="ModelicaServices"
+
+[Complex]
+version="3.2.3"
+name="Complex"

power_balance/environment/modelica.toml

@@ -152,14 +152,15 @@ def check_sweep(cls, values: typing.Dict[str, typing.Any]):
     def check_model_list(cls, values: typing.Dict):
         modelica_file_dir = values["modelica_file_directory"]
 
-        _local_models = list(
-            get_local_models(
-                model_file_dir=modelica_file_dir,
-                names_only=True,
-                session=pydelica.Session(),
-                quiet=True,
+        with pydelica.Session() as pd_session:
+            _local_models = list(
+                get_local_models(
+                    model_file_dir=modelica_file_dir,
+                    names_only=True,
+                    session=pd_session,
+                    quiet=True,
+                )
             )
-        )
 
         for model in values["models"]:
             if model not in _local_models: