Merge branch 'dev' into kzscisoft/filter-object

Author: kzscisoft

.github/PULL_REQUEST_TEMPLATE/bug_fix.md

@@ -0,0 +1,22 @@
+# <Title of Bug Fix>
+
+**Issue:** Link to the issue relating to this bug.
+**Python Version(s) Tested:** Python versions this fix has been verified against.
+**Operating System(s):** Operating systems this fix has been tested in.
+
+## 📝 Summary
+
+Please provide a summary of the original bug, and the fix implemented to address it.
+
+## 🔍 Diagnosis
+
+If applicable, please summarise any information relating to how the bug was identified, and the root causes.
+
+## 🔄 Changes
+
+Provide any additional detail on the changes applied to address the issue.
+
+## ✔️ Checklist
+- [ ] Unit and integration tests passing.
+- [ ] Pre-commit hooks passing.
+- [ ] Quality checks passing.

.github/PULL_REQUEST_TEMPLATE/feature.md

@@ -0,0 +1,20 @@
+# <Feature Title>
+
+**Issue:** Link to the issue proposing this feature.
+**Python Version(s) Tested:** Python versions this feature has been tested on.
+**Operating System(s):** Operating systems this feature has been tested on.
+**Documentation PR:** Issue on [Docs repo](https://github.com/simvue-io/docs).
+
+## 📝 Summary
+
+Please provide a summary of the feature including why it is beneficial to other users.
+
+## 🔄 Changes
+
+Outline the changes/additions made to implement this feature.
+
+## ✔️ Checklist
+- [ ] Unit and integration tests passing.
+- [ ] Pre-commit hooks passing.
+- [ ] Quality checks passing.
+- [ ] Updated the [documentation](https://github.com/simvue-io/docs).

.github/pull_request_template.md

@@ -0,0 +1,5 @@
+Please select from the following templates by clicking 'Preview' and then the relevant link:
+
+🆕 [**Feature**](?expand=1&template=feature.md)
+
+🐛 [**Bug Fix**](?expand=1&template=bug_fix.md)

.github/workflows/deploy.yaml

@@ -79,7 +79,7 @@ jobs:
           name: python-package-distributions
           path: dist/
       - name: Sign the dists with Sigstore
-        uses: sigstore/gh-action-sigstore-python@v3
+        uses: sigstore/gh-action-sigstore-python@v3.0.0
         with:
           inputs: >-
             ./dist/*.tar.gz

.github/workflows/test_client_macos.yml

@@ -15,11 +15,11 @@ jobs:
     timeout-minutes: 30
     runs-on: macos-latest
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python 3.12
-      uses: actions/setup-python@v3
+    - uses: actions/checkout@v4
+    - name: Set up Python 3.13
+      uses: actions/setup-python@v5
       with:
-        python-version: "3.12"
+        python-version: "3.13"
     - name: Install dependencies
       run: |
         rm poetry.lock

.github/workflows/test_client_ubuntu.yml

@@ -23,20 +23,20 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 30
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python 3.12
-      uses: actions/setup-python@v3
+    - uses: actions/checkout@v4
+    - name: Set up Python 3.13
+      uses: actions/setup-python@v5
       with:
-        python-version: "3.12"
+        python-version: "3.13"
     - name: Install dependencies
       run: python -m pip install poetry
     - name: Test with pytest
       run: |
         export SIMVUE_URL=${{ secrets.SIMVUE_URL }}
         export SIMVUE_TOKEN=${{ secrets.SIMVUE_TOKEN }}
         poetry install --all-extras
-        poetry run python -m pip install torch --index-url https://download.pytorch.org/whl/cpu
-        poetry run pytest -x --cov --cov-report=xml tests/unit/ tests/refactor/ -m 'not scenario'
+        # poetry run python -m pip install torch --index-url https://download.pytorch.org/whl/cpu FIXME: PyTorch current broken for Python3.13
+        poetry run pytest -x --cov --cov-report=xml tests/unit/ tests/refactor/ -m 'not scenario' -c /dev/null -p no:warnings -n 0
     - name: Upload coverage reports to Codecov
       run: |
         curl -Os https://uploader.codecov.io/latest/linux/codecov

.github/workflows/test_multiple_python.yml

@@ -22,7 +22,7 @@ jobs:
     timeout-minutes: 30
     strategy:
         matrix:
-            python-version: ['3.9', '3.10', '3.11']
+            python-version: ['3.10', '3.11', '3.12']
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}

.gitignore

@@ -134,6 +134,7 @@ dmypy.json
 
 # Simvue files
 simvue.ini
+simvue.toml
 offline/
 
 # Pyenv

.pre-commit-config.yaml

@@ -1,4 +1,4 @@
-exclude: '^tests|^docs'
+exclude: '^tests|^docs|^examples|^notebooks'
 ci:
     autofix_prs: false
     autoupdate_branch: ''
@@ -8,7 +8,7 @@ ci:
     submodules: false
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v5.0.0
     hooks:
       - id: check-toml
       - id: check-yaml
@@ -23,7 +23,7 @@ repos:
         args: [--branch, main, --branch, dev]
       - id: check-added-large-files
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.6.7
+    rev: v0.7.0
     hooks:
       - id: ruff
         args: [ --fix, --exit-non-zero-on-fix, "--ignore=C901" ]
@@ -35,7 +35,7 @@ repos:
         pass_filenames: false
 
   - repo: https://github.com/PyCQA/bandit.git
-    rev: 1.7.9
+    rev: 1.7.10
     hooks:
     -   id: bandit
         args: [-lll, --recursive, clumper]

CHANGELOG.md

@@ -1,5 +1,35 @@
 # Change log
 
+## Unreleased
+
+* Drop support for INI based configuration files.
+
+## [v1.1.1](https://github.com/simvue-io/client/releases/tag/v1.1.1) - 2024-10-22
+
+* Add missing `offline.cache` key to TOML config.
+* Fix repetition of server URL validation for each call to configuration.
+
+## [v1.1.0](https://github.com/simvue-io/client/releases/tag/v1.1.0) - 2024-10-21
+
+* Add option to specify a callback executed when an alert is triggered for a run.
+* Allow retrieval of all alerts when no constraints are specified.
+* Add carbon emissions statistics as optional metrics.
+* Include Python and Rust environment metadata.
+* Allow the disabling of heartbeat to allow runs to continue indefinitely.
+* Verify Simvue server URL as early as possible.
+* Indicate the source used for token and URL.
+* Migrate to `simvue.toml` from `simvue.ini`, allowing more defaults to be set during runs.
+
+## [v1.0.6](https://github.com/simvue-io/client/releases/tag/v1.0.6) - 2024-10-10
+
+* Fix incorrect usage of `retry` when attempting connections to the server.
+
+## [v1.0.5](https://github.com/simvue-io/client/releases/tag/v1.0.5) - 2024-10-09
+
+* Ensure all functionality is deactivated when mode is set to `disabled`.
+* When an exception is thrown an event is sent to Simvue displaying the traceback.
+* If `add_process` is used and an exception is thrown, `.err` and `.out` files are still uploaded.
+
 ## [v1.0.4](https://github.com/simvue-io/client/releases/tag/v1.0.4) - 2024-09-24
 
 * Set resource metrics to be recorded by default.