Fix-test_end_scenario_sizing_head_loss

.gitattributes

@@ -1 +1 @@
-src/rtctools_heat_network/_version.py export-subst
+src/mesido/_version.py export-subst

.github/workflows/ci.yml

@@ -1,14 +1,23 @@
 name: PyPi release
 run-name: CI pipeline
 on:
-  push:
+  pull_request:
     branches:
       - '*'
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - ready_for_review
+  push:
+    branches:
+      - main
 
 jobs:
   style:
     name: Check style
     runs-on: ubuntu-latest
+    if: ${{ !github.event.pull_request.draft }}
     env:
       TOXENV: flake8,black
     steps:
@@ -27,6 +36,7 @@ jobs:
   build:
     name: Check build
     runs-on: ubuntu-latest
+    if: ${{ !github.event.pull_request.draft }}
     steps:
       - uses: actions/checkout@v3
 
@@ -39,10 +49,12 @@ jobs:
 
       - name: Check build
         run: python setup.py sdist bdist_wheel
-
-  test:
-    name: Check test
+
+  # Main testing
+  test_main:
+    name: Test main
     runs-on: ubuntu-latest
+    if: ${{ !github.event.pull_request.draft }}
     env:
       TOXENV: py38
     steps:
@@ -54,13 +66,81 @@ jobs:
 
       - name: deps
         run: python -m pip install -U tox
+
+      - name: Check test
+        run: tox -vv -etest_env_main
+
+  # Pre-processing testing
+  test_pre_processing:
+    name: Test pre-processing
+    runs-on: ubuntu-latest
+    if: ${{ !github.event.pull_request.draft }}
+    env:
+      TOXENV: py38
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.8"
 
+      - name: deps
+        run: python -m pip install -U tox
+
       - name: Check test
-        run: tox -vv
+        run: tox -vv -etest_env_pre
 
+      - name: Upload results
+        uses: actions/upload-artifact@v4
+        with:
+          name: updated_esdl_file
+          path: examples/PoCTutorial/model/PoC Tutorial_GrowOptimized.esdl
+          retention-days: 5
+
+      - name: Upload results
+        uses: actions/upload-artifact@v4
+        with:
+          name: updated_esdl_string_file
+          path: examples/PoCTutorial/model/PoC Tutorial_GrowOptimized_esdl_string.esdl
+          retention-days: 5
+
+
+  # Post processing testing dependant on pre-processing
+  test_post_processing:
+    name: Test post-processing
+    needs: test_pre_processing
+    runs-on: ubuntu-latest
+    if: ${{ !github.event.pull_request.draft }}
+    env:
+      TOXENV: py38
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.8"
+
+      - name: deps
+        run: python -m pip install -U tox
+
+      - name: Archive test artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: updated_esdl_file
+          path: examples/PoCTutorial/model/     
+      - name: Archive test artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: updated_esdl_string_file
+          path: examples/PoCTutorial/model/  
+
+      - name: Check test
+        run: tox -vv -etest_env_post
+
   documentation:
     name: Generate documentation
     runs-on: ubuntu-latest
+    if: ${{ !github.event.pull_request.draft }}
     steps:
       - uses: actions/checkout@v3
 

.gitignore

@@ -25,9 +25,18 @@ src/*.egg-info
 .ipynb_checkpoints
 .vscode
 
-# Kobus van Rooyen
-run_pipe_compare.py
-.venv/
+# Abbreviation to be added to files/folders name
+# Meaning of abbreviation: exclude from version control
+*_efvc_*
+
 # Ignore ESDL files created by workflows
 *_GrowOptimized.esdl 
+*_GrowOptimized_esdl_string.esdl 
 *_Simulation.esdl
+
+# Virtual environment files
+.venv/*
+
+# Docs build folder
+docs/_build/*
+docs/_build_kvr_

.gitlab-ci.yml

@@ -33,7 +33,12 @@ build:
 py37:linux:
   stage: test
   script:
-    - tox -vv
+    - echo "Demo" > Demo.txt
+  artifacts: 
+    paths: 
+      - ./Demo.txt
+      # - ./PoC Tutorial_GrowOptimized.esdl
+    expire_in: 1 week
   image: python:3.7
   variables:
     TOXENV: py37

CHANGELOG.md

@@ -0,0 +1,186 @@
+# [Unreleased-main] - 2025-06-25
+
+## Added
+- xx
+
+## Changed
+- Previously variable operational cost of air-to-water heat pump was based on  the thermal power usage. Now it is based on the electrical power usage
+
+## Fixed
+- xxx
+
+
+# [0.1.13] - 2025-06-25
+
+## Added
+- xx
+
+## Changed
+- README update mesido install command for dev
+
+## Fixed
+- Bug: Producer profiles specified in Watts and asset state=ENABLED
+
+
+# [0.1.12] - 2025-06-12
+
+## Added
+- Maximum profile contraint (specified in Watts) to some heat producers
+
+## Changed
+- xx
+
+## Fixed
+- xx
+
+
+# [0.1.11] - 2025-05-21
+
+## Added
+- xx
+
+## Changed
+- Updated pyESDL to v25.5.1
+
+## Fixed
+- xx
+
+
+# [0.1.10] - 2025-05-20
+
+## Added
+- Default database for gas pipe dimensions based on the ASA pipe schedule with thicknesses from the standard class
+- Gas and electricity workflow has been added. Still a work in progress
+- Internal energy content function added for natural gas and hydrogen
+- OPEX added for gas and electricity source
+- Commodity annotation for assets, to allow for easier postprocessing
+- Added function to make pickle usable (exceptions) in the OMOTES back end
+- More of the existing classes added to __init_ for local runs using the grow_workflow
+- Generic functions for postprocessing are added.
+- Generic function to adapt timeseries from hourly timesteps to user-defined timesteps by averaging.
+- Error check for NaN values in profile data (csv & influxDB)
+- Specify package (deepdiff used in pandapipes validation test) version number in test environment
+- Reset POTENTIAL_ERRORS class instance (Singleton) in grow_workflow due to it being persistent
+- Estimate grow worlfow progress status and update OMOTES progress status 
+
+## Changed
+- Updated the Financial section of the documentation to explain the annualized discounted costs calculation.
+- Write output to json also saves the solver statistics.
+- Updates in asset conversion from ESDL to pycml; gas and heat pipe split, generic conversion better specified.
+- Adapt profiles for heating and cooling peak day separately & add test case
+- For gas: Use energy content (heating value) instead of internal energy 
+- Option was added to allow a bypass of the heat exchanger, possible on both sides of the heat exchanger
+- Option for electricity cables to be unidirectional
+- Upgraded rtctools to v 2.6.1
+- Updated Casadi to 3.6.7 with gil fixes (see https://github.com/casadi/casadi/releases/tag/nightly-gil_release)
+- Definition of power attribute of water-to-water heat pump is changed from electrical power to secondary heat power
+- Enforce water-to-water heat pump upper bound heat capacity to conform to elect_power*cop
+
+## Fixed
+- Bugfix: gas boiler mass flow constraint units
+- Bugfix: same mip gap settings for all solvers in grow_workflow.
+- Bugfix: head loss test case when minimum_velocity = 0.0
+- Bugs: state update of heat pump, heat buffer volume & ates charge rates update in ESDL, heat storage asset data output to influxDB  
+- Bugfix: get_density + get_internal_energy updated to ensure it checks commodity type for heat instead of the carrier name
+- Bug: pipe class bounds when pipe DN none results from stage 1 in the grow_workflow
+
+
+# [0.1.8.5] - 2025-02-12
+
+## Added
+- xx
+
+## Changed
+- Updated Casadi to 3.6.7 with gil fixes (see https://github.com/casadi/casadi/releases/tag/nightly-gil_release)
+- Upgraded rtctools to version 2.6.1
+
+## Fixed
+- Bug: pipe class bounds when pipe DN none results from stage 1 in the grow_workflow
+
+
+# [0.1.8.4] - 2024-12-11
+
+## Added
+- More of the existing classes added to __init_ for local runs using the grow_workflow
+
+## Changed
+- xxx
+
+## Fixed
+- Bugs: state update of heat pump, heat buffer volume & ates charge rates update in ESDL, heat storage asset data output to influxDB   
+
+
+# [0.1.8.3] - 2024-12-02
+
+## Added
+- Added function to make pickle usable (exceptions) in the OMOTES back end 
+
+## Changed
+- xx
+
+## Fixed
+- Bugfix: same mip gap settings for all solvers in grow_workflow.
+- Bugfix: head loss test case when minimum_velocity = 0.0
+
+
+# [0.1.8.2] - 2024-11-15
+
+## Added
+- xx
+
+## Changed
+- xx
+
+## Fixed
+- Bugfix: same mip gap settings for all solvers in grow_workflow.
+- Bugfix: head loss test case when minimum_velocity = 0.0
+
+
+# [0.1.8 & 0.1.8.1] - 2024-11-07
+
+## Added
+- Added MESIDO error exception class to raise applicable potential errors in a workflow & include required info for feedback in the mapeditor
+- Limit the available pipe classes connetced to heat/gas demand/producers
+- Add demands and sources to the topology object to have easy access to the connected pipes/cables later on
+- Heating and cooling example case added (2 heating demands, 1 cold demand, hot and cold producer, WKO as seasonal storage)
+- Gas physics documentation
+- Gas & electricity 1st version of physics documentation
+- Test case: Head loss validation with pandapipes.
+- Example on ESDL file creation using pyESDL for the PoC Tutorial.
+- Electrolyzer specific power curve valley location specified optionally specified in ESDL.
+- Grow_workflow: Solver class created to allow the use of CPLEX as a solver for EndScenarioSizing classes. 
+
+## Changed
+- Cooling demand added to adapt_hourly_year_profile_to_day_averaged_with_hourly_peak_day (peak cooling day not used yet)
+- Impact on the way EndScenarioSizing problems in MESIDO are run: The calling of the different optimization problem classes has been split from the solver classes. In EndScenarioSizing classes, the HIGHS solver is the default and the calling functions also cather for other solvers by adding the keyword "solver_class" with the respective solver class.
+- Bugfix: No longer required to provide a power at the heating demands when a profile has been added.
+- Bugfix: Scaling fix on ATES temperature variable when temperature modelling not used.
+- Bugfix: Fix on nominals in electricity cables and gas pipes. Fix on nominals for nodes with logical links.
+- Pipeline is only run when pull request is ready for review and synchronized or when opened, as well as when a pull request is merged to main.
+- Speedup: Changed the way daily average profiles are created from hourly profiles to speed up the conversion.
+
+## Fixed
+- Bug fix: Logical links: e_boiler & gas boiler update to use energy values 
+- Bug fix: Q max and nominal calculation update when reference energy value    
+- Bug fix: e-boiler expected order of inports while setting nominal values
+- Bug fix: setting nominals while using logical links when all values are 1.0
+- Bug fix: machine error/rounding with updating lower bound values in the grow_workflow after stage 1
+- documentation: heat physics tank storage
+- bug fix in grow_workflow (heat networks), changed minimum velocity from 0 to default value
+- addition to tests checking the minimum velocity setting in a workflow
+
+
+# [0.1.7] - 2024-08-23
+
+## Added
+- User feedback regarding demand type to be used in heat networks 
+- Functionality to connect assets with logical links 
+
+## Changed
+- Increased time limit for stage 1, priority 1
+- Replaced Retry loop to connect all assets and apply the correct modifiers of the linked assets
+
+## Fixed
+- Error exit when stage 1, priority 1 was not successful
+
+

MANIFEST.in

@@ -1,4 +1,6 @@
-recursive-include src/rtctools_heat_network/modelica/WarmingUp *
+recursive-include src/mesido/modelica/WarmingUp *
 include versioneer.py
-include src/rtctools_heat_network/_version.py
-include src/rtctools_heat_network/esdl/_edr_pipes.json
+include src/mesido/_version.py
+include src/mesido/esdl/_edr_pipes.json
+include src/mesido/esdl/_gas_pipe_database.json
+include additional_info_for_license.txt