Ecoclient Simvue Python API Extension

.github/workflows/test_client_ubuntu.yml

@@ -18,8 +18,95 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  build:
-
+  online_unit_tests:
+    runs-on: ubuntu-latest
+    timeout-minutes: 40
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python 3.13
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.13"
+    - name: Install dependencies
+      run: |
+        python -m pip install poetry
+        poetry self add poetry-plugin-export
+        poetry export -f requirements.txt --with dev -o requirements.txt --all-extras
+        python -m pip install torch --index-url https://download.pytorch.org/whl/cpu
+        python -m pip install -r requirements.txt
+        python -m pip install .
+    - name: Test with pytest
+      env:
+        SIMVUE_URL: ${{ secrets.SIMVUE_URL }}
+        SIMVUE_TOKEN: ${{ secrets.SIMVUE_TOKEN }}
+      run: python -m pytest tests/unit/ -x  -m online -c /dev/null -p no:warnings -n 0 -v
+  offline_unit_tests:
+    runs-on: ubuntu-latest
+    timeout-minutes: 40
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python 3.13
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.13"
+    - name: Install dependencies
+      run: |
+        python -m pip install poetry
+        poetry self add poetry-plugin-export
+        poetry export -f requirements.txt --with dev -o requirements.txt --all-extras
+        python -m pip install torch --index-url https://download.pytorch.org/whl/cpu
+        python -m pip install -r requirements.txt
+        python -m pip install .
+    - name: Test with pytest
+      env:
+        SIMVUE_URL: ${{ secrets.SIMVUE_URL }}
+        SIMVUE_TOKEN: ${{ secrets.SIMVUE_TOKEN }}
+      run: python -m pytest tests/unit/ -x  -m offline -c /dev/null -p no:warnings -n 0 -v
+  online_functional_tests:
+    runs-on: ubuntu-latest
+    timeout-minutes: 40
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python 3.13
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.13"
+    - name: Install dependencies
+      run: |
+        python -m pip install poetry
+        poetry self add poetry-plugin-export
+        poetry export -f requirements.txt --with dev -o requirements.txt --all-extras
+        python -m pip install torch --index-url https://download.pytorch.org/whl/cpu
+        python -m pip install -r requirements.txt
+        python -m pip install .
+    - name: Test with pytest
+      env:
+        SIMVUE_URL: ${{ secrets.SIMVUE_URL }}
+        SIMVUE_TOKEN: ${{ secrets.SIMVUE_TOKEN }}
+      run: python -m pytest tests/functional/ -x  -m online -c /dev/null -p no:warnings -n 0 -v
+  offline_functional_tests:
+    runs-on: ubuntu-latest
+    timeout-minutes: 40
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python 3.13
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.13"
+    - name: Install dependencies
+      run: |
+        python -m pip install poetry
+        poetry self add poetry-plugin-export
+        poetry export -f requirements.txt --with dev -o requirements.txt --all-extras
+        python -m pip install torch --index-url https://download.pytorch.org/whl/cpu
+        python -m pip install -r requirements.txt
+        python -m pip install .
+    - name: Test with pytest
+      env:
+        SIMVUE_URL: ${{ secrets.SIMVUE_URL }}
+        SIMVUE_TOKEN: ${{ secrets.SIMVUE_TOKEN }}
+      run: python -m pytest tests/functional/ -x  -m offline -c /dev/null -p no:warnings -n 0 -v
+  other_unit_tests:
     runs-on: ubuntu-latest
     timeout-minutes: 40
     steps:
@@ -40,9 +127,26 @@ jobs:
       env:
         SIMVUE_URL: ${{ secrets.SIMVUE_URL }}
         SIMVUE_TOKEN: ${{ secrets.SIMVUE_TOKEN }}
-      run: python -m pytest tests/ -x --cov --cov-report=xml -m 'not scenario' -c /dev/null -p no:warnings -n 0 -v
-    - name: Upload coverage reports to Codecov
+      run: python -m pytest tests/unit/ -x  -m 'not offline' -m 'not online' -m 'not scenario' -c /dev/null -p no:warnings -n 0 -v
+  other_functional_tests:
+    runs-on: ubuntu-latest
+    timeout-minutes: 40
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python 3.13
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.13"
+    - name: Install dependencies
       run: |
-        curl -Os https://uploader.codecov.io/latest/linux/codecov
-        chmod +x codecov
-        ./codecov -t ${CODECOV_TOKEN}
+        python -m pip install poetry
+        poetry self add poetry-plugin-export
+        poetry export -f requirements.txt --with dev -o requirements.txt --all-extras
+        python -m pip install torch --index-url https://download.pytorch.org/whl/cpu
+        python -m pip install -r requirements.txt
+        python -m pip install .
+    - name: Test with pytest
+      env:
+        SIMVUE_URL: ${{ secrets.SIMVUE_URL }}
+        SIMVUE_TOKEN: ${{ secrets.SIMVUE_TOKEN }}
+      run: python -m pytest tests/functional/ -x  -m 'not offline' -m 'not online' -m 'not scenario' -c /dev/null -p no:warnings -n 0 -v

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change log
-
 ## Unreleased
+* Removed CodeCarbon dependence in favour of a slimmer solution using the CO2 Signal API.
 * Added sorting to server queries, users can now specify to sort by columns during data retrieval from the database.
 ## [v2.0.1](https://github.com/simvue-io/client/releases/tag/v2.0.1) - 2025-03-24
 * Improvements to docstrings on methods, classes and functions.

CITATION.cff

@@ -42,67 +42,5 @@ keywords:
   - alerting
   - simulation
 license: Apache-2.0
-commit: 5084f9c17ae4b7f77e188f5aa8a51ebd3f790c9e
 version: 2.0.1
 date-released: '2025-03-24'
-references:
-- title: mlco2/codecarbon
-  version: v2.8.2
-  type: software
-  date-released: 2024-12-08
-  doi: 10.5281/zenodo.14518377
-  url: https://doi.org/10.5281/zenodo.14518377
-  repository-code: https://github.com/mlco2/codecarbon
-  authors:
-    - given-names: Benoit
-      family-names: Courty
-    - given-names: Victor
-      family-names: Schmidt
-    - given-names: Sasha
-      family-names: Luccioni
-    - given-names: Goyal
-      family-names: Kamal
-    - given-names: Marion
-      family-names: Coutarel
-    - given-names: Boris
-      family-names: Feld
-    - given-names: Jérémy
-      family-names: Lecourt
-    - given-names: Liam
-      family-names: Connell
-    - given-names: Amine
-      family-names: Saboni
-    - given-names: Mathilde
-      family-names: Léval
-    - given-names: Luis
-      family-names: Blanche
-    - given-names: Alexis
-      family-names: Cruveiller
-    - given-names: Franklin
-      family-names: Zhao
-    - given-names: Aditya
-      family-names: Joshi
-    - given-names: Alexis
-      family-names: Bogroff
-    - given-names: Hugues
-      family-names: de Lavoreille
-    - given-names: Niko
-      family-names: Laskaris
-    - given-names: Edoardo
-      family-names: Abati
-    - given-names: Douglas
-      family-names: Blank
-    - given-names: Ziyao
-      family-names: Wang
-    - given-names: Armin
-      family-names: Catovic
-    - given-names: Marc
-      family-names: Alencon
-    - given-names: Michał
-      family-names: Stęchły
-    - given-names: Christian
-      family-names: Bauer
-    - given-names: Lucas Otávio N.
-      family-names: de Araújo
-    - given-names: Minerva
-      family-names: Books