Merge remote-tracking branch 'origin/main' into remove-pacs

Author: alexdewar

.github/actions/codecov/action.yml

@@ -0,0 +1,23 @@
+name: Code coverage
+description: Generate code coverage and upload to codecov
+inputs:
+  token:
+    description: Codecov token
+    required: true
+
+runs:
+  using: composite
+  steps:
+    - name: Install cargo-llvm-cov
+      shell: bash
+      run: cargo install cargo-llvm-cov
+
+    - name: Generate code coverage
+      shell: bash
+      run: cargo llvm-cov --codecov --output-path codecov.json
+
+    - name: Upload to codecov.io
+      uses: codecov/codecov-action@v5
+      with:
+        token: ${{ inputs.token }}
+        fail_ci_if_error: true

.github/workflows/cargo-build-and-test.yml

@@ -0,0 +1,31 @@
+name: Cargo Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  build_and_test:
+    name: Run tests
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 15
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        include:
+          - os: ubuntu-latest
+            coverage: true
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          toolchain: stable
+      - run: cargo test --verbose
+
+      - if: ${{ matrix.coverage }}
+        uses: ./.github/actions/codecov
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/cargo-test.yml

@@ -3,6 +3,7 @@ on:
   push:
     branches: [main]
   pull_request:
+  workflow_dispatch:
   schedule:
     - cron: "0 0 * * 1" # midnight every Monday
 

.github/workflows/check-docs.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches: [main]
   pull_request:
+  workflow_dispatch:
 
 jobs:
   pre-commit:

.github/workflows/pre-commit.yml

@@ -0,0 +1,66 @@
+name: Release
+on:
+  push:
+    branches: [main]
+  release:
+  workflow_dispatch:
+
+jobs:
+  build_and_upload:
+    name: Build release
+    timeout-minutes: 15
+    runs-on: ${{ matrix.os }}
+    container:
+      image: ${{ matrix.image }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        archive_ext: [tar.gz]
+        archive_cmd: ["tar cf"]
+        include:
+          - os: ubuntu-latest
+            osname: linux
+            # We build on an old Linux distro so that we get an older version of libstdc++.
+            # libstdc++ has good backwards compatibility (but not forwards) so by linking against an
+            # old version, we can target more Linuxes.
+            image: debian:oldstable
+          - os: windows-latest
+            osname: windows
+            archive_ext: zip
+            archive_cmd: 7z a
+            exe_suffix: .exe
+          - os: macos-latest
+            osname: macos_arm
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install extra dependencies on Linux
+        if: ${{ matrix.osname == 'linux' }}
+        run: |
+          apt update
+          apt install -y curl build-essential cmake libclang-16-dev
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          toolchain: stable
+      - run: cargo build --release
+      - name: Gather release files
+        run: |
+          mkdir muse2
+          cp target/release/muse2${{ matrix.exe_suffix }} muse2
+          cp LICENSE muse2/LICENCE.txt
+          cp assets/readme/readme_${{ matrix.osname }}.txt muse2/README.txt
+      - uses: actions/upload-artifact@v4
+        if: ${{ github.event_name != 'release' }}
+        with:
+          name: muse2_${{ matrix.osname }}
+          path: muse2
+      - name: Archive release
+        if: ${{ github.event_name == 'release' }}
+        run: |
+          cd muse2
+          ${{ matrix.archive_cmd }} ../muse2_${{ matrix.osname }}.${{ matrix.archive_ext }} *
+      - name: Upload release artifacts
+        if: ${{ github.event_name == 'release' }}
+        uses: softprops/action-gh-release@v2
+        with:
+          files: muse2_${{ matrix.osname }}.${{ matrix.archive_ext }}

.github/workflows/release.yml

@@ -26,6 +26,14 @@ repos:
     rev: v1.0
     hooks:
       - id: clippy
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.6
+    hooks:
+      - id: ruff
+        types_or: [python]
+        args: [--fix]
+      - id: ruff-format
+        types_or: [python]
   - repo: https://github.com/codespell-project/codespell
     rev: v2.2.6
     hooks:

.pre-commit-config.yaml

@@ -4,6 +4,9 @@
         "vadimcn.vscode-lldb",
         "editorconfig.editorconfig",
         "esbenp.prettier-vscode",
-        "davidanson.vscode-markdownlint"
+        "davidanson.vscode-markdownlint",
+        "samuelcolvin.jinjahtml",
+        "ms-python.python",
+        "charliermarsh.ruff"
     ]
 }

.vscode/extensions.json

@@ -1,5 +1,5 @@
 <!-- markdownlint-disable MD041 -->
-[![Build and test](https://github.com/EnergySystemsModellingLab/MUSE_2.0/actions/workflows/cargo-build-and-test.yml/badge.svg)](https://github.com/EnergySystemsModellingLab/MUSE_2.0/actions/workflows/cargo-build-and-test.yml)
+[![Build and test](https://github.com/EnergySystemsModellingLab/MUSE_2.0/actions/workflows/cargo-test.yml/badge.svg)](https://github.com/EnergySystemsModellingLab/MUSE_2.0/actions/workflows/cargo-test.yml)
 [![codecov](https://codecov.io/github/EnergySystemsModellingLab/MUSE_2.0/graph/badge.svg?token=nV8gp1NCh8)](https://codecov.io/github/EnergySystemsModellingLab/MUSE_2.0)
 [![GitHub](https://img.shields.io/github/license/EnergySystemsModellingLab/MUSE_2.0)](https://raw.githubusercontent.com/EnergySystemsModellingLab/MUSE_2.0/main/LICENSE)
 

README.md

@@ -0,0 +1,3 @@
+# Readme files for MUSE 2.0
+
+This folder contains readme files to be included with MUSE 2.0 releases.