Merge branch 'main' into prices_fix

tsmbland · web-flow · commit a89462cf0f8a · 2026-03-03T11:39:55.000Z
diff --git a/.github/workflows/auto-merge.yml b/.github/workflows/auto-merge.yml
@@ -15,7 +15,7 @@ jobs:
       - name: Enable auto-merge for bot PRs
         run: |
           gh pr review --approve "$PR_URL"
-          gh pr merge --auto --merge "$PR_URL"
+          gh pr merge --auto --rebase "$PR_URL"
         env:
           PR_URL: ${{github.event.pull_request.html_url}}
           # GitHub provides this variable in the CI env. You don't
diff --git a/.github/workflows/cargo-test.yml b/.github/workflows/cargo-test.yml
@@ -30,7 +30,7 @@ jobs:
           cargo test --verbose --no-fail-fast
 
       # Upload regression test results for analysis
-      - uses: actions/upload-artifact@v6
+      - uses: actions/upload-artifact@v7
         if: "!cancelled()"
         with:
           name: muse2_test_results_${{ matrix.os }}
diff --git a/.github/workflows/check-docs.yml b/.github/workflows/check-docs.yml
@@ -19,4 +19,4 @@ jobs:
         id: lychee
         uses: lycheeverse/lychee-action@v2
         with:
-          args: "--verbose --no-progress --accept 200,203,503 --exclude-path ^target './**/*.md' './**/*.html'"
+          args: "--verbose --no-progress --accept 200,203,503 --exclude-path ^target --exclude-path ^book/404.html$ './**/*.md' './**/*.html'"
diff --git a/.github/workflows/pre-commit-autoupdate.yml b/.github/workflows/pre-commit-autoupdate.yml
@@ -0,0 +1,27 @@
+name: Pre-commit auto-update
+
+on:
+  schedule:
+    - cron: 0 0 * * 1 # midnight every Monday
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  auto-update:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          persist-credentials: false
+      - uses: actions/setup-python@v5
+      - uses: browniebroke/pre-commit-autoupdate-action@main
+      - uses: peter-evans/create-pull-request@v7
+        with:
+          token: ${{ secrets.GH_TOKEN_FOR_UPDATES }}
+          branch: update/pre-commit-hooks
+          title: Update pre-commit hooks
+          commit-message: "chore: update pre-commit hooks"
+          body: Update versions of pre-commit hooks to latest version.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -48,7 +48,7 @@ jobs:
           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@v6
+      - uses: actions/upload-artifact@v7
         if: ${{ github.event_name != 'release' }}
         with:
           name: muse2_${{ matrix.osname }}
diff --git a/.github/workflows/update-rust-toolchain.yml b/.github/workflows/update-rust-toolchain.yml
@@ -14,7 +14,7 @@ jobs:
         with:
           persist-credentials: false
       - name: update rust toolchain
-        uses: a-kenji/update-rust-toolchain@v1
+        uses: a-kenji/update-rust-toolchain@v1.1
         with:
           toolchain-path: ./rust-toolchain.toml
           token: ${{ secrets.GH_TOKEN_FOR_UPDATES }}
diff --git a/.lycheeignore b/.lycheeignore
@@ -1,6 +1,9 @@
 # For some reason these spurious links appear in some cargo doc-generated files
 ^file://.+/MUSE2/book/api/index\.html$
 
+# Some of these links give a 404, even though they're generated in the API docs. No idea why.
+^https://docs.rs/erased-serde/
+
 # Times out on GitHub runner
 ^http://www.adobe.com
 
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,13 +1,13 @@
 exclude: ^schemas/table-schema.json$
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v6.0.0
     hooks:
       - id: check-merge-conflict
       - id: trailing-whitespace
       - id: end-of-file-fixer
   - repo: https://github.com/python-jsonschema/check-jsonschema
-    rev: 0.33.2
+    rev: 0.37.0
     hooks:
       - id: check-dependabot
       - id: check-github-actions
@@ -31,16 +31,16 @@ repos:
         files: /settings\.toml$
         types_or: [toml]
   - repo: https://github.com/igorshubovych/markdownlint-cli
-    rev: v0.38.0
+    rev: v0.47.0
     hooks:
       - id: markdownlint-fix
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: "v3.1.0"
+    rev: "v4.0.0-alpha.8"
     hooks:
       - id: prettier
         types_or: [yaml, json]
   - repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
-    rev: v2.13.0
+    rev: v2.16.0
     hooks:
       - id: pretty-format-toml
         args: [--autofix, --indent, "4", --no-sort]
@@ -53,19 +53,19 @@ repos:
       - id: clippy
         args: ["--all-targets", "--", "-D", "warnings"]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.11.6
+    rev: v0.15.4
     hooks:
-      - id: ruff
+      - id: ruff-check
         types_or: [python]
         args: [--fix]
       - id: ruff-format
         types_or: [python]
   - repo: https://github.com/kynan/nbstripout
-    rev: 0.8.1
+    rev: 0.9.1
     hooks:
       - id: nbstripout
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.2.6
+    rev: v2.4.1
     hooks:
       - id: codespell
         args: [--ignore-words, .codespell_ignore.txt]
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -19,7 +19,7 @@ float-cmp = "0.10.0"
 itertools = "0.14.0"
 serde = {version = "1.0.228", features = ["derive", "rc"]}
 serde_string_enum = "0.2.1"
-tempfile = "3.25.0"
+tempfile = "3.26.0"
 toml = "1.0.3"
 unicase = "2.9.0"
 fern = {version = "0.7.1", features = ["chrono", "colored"]}
diff --git a/docs/model/investment.md b/docs/model/investment.md
@@ -3,10 +3,10 @@
 <!-- markdownlint-disable MD049 -->
 
 This section details the investment and asset retention decision process, which is applied within
-step 2 of the [overall MUSE2 workflow]. This process determines which new assets to build and
-which existing assets to retain to meet system needs over time. In the overall workflow, dispatch
-optimisation is used to identify *physical needs* by quantifying demand profiles for commodities of
-interest.
+step 2 of the [overall MUSE2 workflow][framework-overview]. This process determines which new assets
+to build and which existing assets to retain to meet system needs over time. In the overall
+workflow, dispatch optimisation is used to identify *physical needs* by quantifying demand profiles
+for commodities of interest.
 
 ## Commodity prices
 
@@ -23,7 +23,7 @@ the preceding MSY. When the `pricing_strategy` option is set to `scarcity_adjust
 shadow prices for each commodity adjusted to remove the impact of binding capacity constraints.
 
 Note: there is an option to iterate over each year so that investment decisions are based on
-equilibrium prices in the _current year_, in what's referred to as the "[ironing-out loop]".
+equilibrium prices in the _current year_, in what's referred to as the "[ironing-out loop][framework-overview]".
 In this case, \\( \lambda\_{c,r,t} \\) will reflect prices from previous iteration of the
 ironing-out loop.
 
@@ -203,6 +203,5 @@ For each asset option:
   AFC \* cap_r + \sum_{t} act_t \* AC_t \\)), divided by the annual output
   \\( \sum_t act_t \\).
 
-[overall MUSE2 workflow]: ./README.md#framework-overview
+[framework-overview]: https://energysystemsmodellinglab.github.io/MUSE2/model/index.html#framework-overview
 [Dispatch Optimisation Formulation]: ./dispatch_optimisation.md
-[ironing-out loop]: ./README.md#framework-overview
diff --git a/rust-toolchain.toml b/rust-toolchain.toml
@@ -1,3 +1,3 @@
 [toolchain]
-channel = "1.93.0"
+channel = "1.93.1"
 profile = "default"
diff --git a/schemas/input/agent_commodity_portions.yaml b/schemas/input/agent_commodity_portions.yaml
@@ -20,7 +20,8 @@ fields:
   - name: years
     type: string
     description: The year(s) to which this entry applies
-    notes: One or more milestone years separated by semicolons, `all` to select all years or a year
+    notes:
+      One or more milestone years separated by semicolons, `all` to select all years or a year
       range in the form 'start..end' to select all valid years within range, inclusive. Either 'start'
       'end' or both can be omitted, which will set the corresponding limit to the minimum or maximum
       valid year, respectively.
diff --git a/schemas/input/agent_objectives.yaml b/schemas/input/agent_objectives.yaml
@@ -16,7 +16,8 @@ fields:
   - name: years
     type: string
     description: The year(s) to which this entry applies
-    notes: One or more milestone years separated by semicolons, `all` to select all years or a year
+    notes:
+      One or more milestone years separated by semicolons, `all` to select all years or a year
       range in the form 'start..end' to select all valid years within range, inclusive. Either 'start'
       'end' or both can be omitted, which will set the corresponding limit to the minimum or maximum
       valid year, respectively.
diff --git a/schemas/input/agent_search_space.yaml b/schemas/input/agent_search_space.yaml
@@ -16,7 +16,8 @@ fields:
   - name: years
     type: string
     description: The year(s) to which this entry applies
-    notes: One or more milestone years separated by semicolons, `all` to select all years or a year
+    notes:
+      One or more milestone years separated by semicolons, `all` to select all years or a year
       range in the form 'start..end' to select all valid years within range, inclusive. Either 'start'
       'end' or both can be omitted, which will set the corresponding limit to the minimum or maximum
       valid year, respectively.
diff --git a/schemas/input/commodity_levies.yaml b/schemas/input/commodity_levies.yaml
@@ -20,7 +20,8 @@ fields:
   - name: years
     type: string
     description: The year(s) to which this entry applies
-    notes: One or more milestone years separated by semicolons, `all` to select all years or a year
+    notes:
+      One or more milestone years separated by semicolons, `all` to select all years or a year
       range in the form 'start..end' to select all valid years within range, inclusive. Either 'start'
       'end' or both can be omitted, which will set the corresponding limit to the minimum or maximum
       valid year, respectively.
diff --git a/schemas/input/demand.yaml b/schemas/input/demand.yaml
@@ -17,7 +17,8 @@ fields:
   - name: year
     type: string
     description: The year(s) to which this entry applies
-    notes: One or more milestone years separated by semicolons, `all` to select all years or a year
+    notes:
+      One or more milestone years separated by semicolons, `all` to select all years or a year
       range in the form 'start..end' to select all valid years within range, inclusive. Either 'start'
       'end' or both can be omitted, which will set the corresponding limit to the minimum or maximum
       valid year, respectively.
diff --git a/schemas/input/model.yaml b/schemas/input/model.yaml
@@ -50,5 +50,12 @@ properties:
     type: boolean
     description: |
       Allows other options that are known to be broken to be used. Please don't ever enable this.
+  remaining_demand_absolute_tolerance:
+    type: number
+    description: |
+      Absolute tolerance when checking if remaining demand is close enough to zero in the
+      investment cycle. Changing the value of this parameter is potentially dangerous,
+      so it requires setting `please_give_me_broken_results` to true.
+    default: 1e-12
 
 required: [milestone_years]
diff --git a/schemas/input/process_availabilities.yaml b/schemas/input/process_availabilities.yaml
@@ -22,7 +22,8 @@ fields:
   - name: years
     type: string
     description: The milestone year(s) to which this entry applies
-    notes: One or more milestone years separated by semicolons, `all` to select all years or a year
+    notes:
+      One or more milestone years separated by semicolons, `all` to select all years or a year
       range in the form 'start..end' to select all valid years within range, inclusive. Either 'start'
       'end' or both can be omitted, which will set the corresponding limit to the minimum or maximum
       valid year, respectively.
diff --git a/schemas/input/process_flows.yaml b/schemas/input/process_flows.yaml
@@ -23,7 +23,8 @@ fields:
   - name: years
     type: string
     description: The year(s) to which this entry applies
-    notes: One or more milestone years separated by semicolons, `all` to select all years or a year
+    notes:
+      One or more milestone years separated by semicolons, `all` to select all years or a year
       range in the form 'start..end' to select all valid years within range, inclusive. Either 'start'
       'end' or both can be omitted, which will set the corresponding limit to the minimum or maximum
       valid year, respectively.
diff --git a/schemas/input/process_parameters.yaml b/schemas/input/process_parameters.yaml
@@ -19,7 +19,8 @@ fields:
   - name: years
     type: string
     description: The milestone year(s) to which this entry applies
-    notes: One or more milestone years separated by semicolons, `all` to select all years or a year
+    notes:
+      One or more milestone years separated by semicolons, `all` to select all years or a year
       range in the form 'start..end' to select all valid years within range, inclusive. Either 'start'
       'end' or both can be omitted, which will set the corresponding limit to the minimum or maximum
       valid year, respectively.
diff --git a/schemas/input/processes.yaml b/schemas/input/processes.yaml
@@ -28,14 +28,17 @@ fields:
     notes: Must be >= to `start_year`
   - name: capacity_to_activity
     type: number
-    description: Factor relating capacity units (e.g. GW) to activity units (e.g. PJ). It is the
+    description:
+      Factor relating capacity units (e.g. GW) to activity units (e.g. PJ). It is the
       maximum activity per year for one unit of capacity.
     notes: Must be >=0. Optional (defaults to 1.0).
   - name: unit_size
     type: number
-    description: Capacity of the units in which an asset for this process will be divided into when
+    description:
+      Capacity of the units in which an asset for this process will be divided into when
       commissioned, if any.
-    notes: If present, must be >0. Optional (defaults to None). Assets with a defined unit size are
+    notes:
+      If present, must be >0. Optional (defaults to None). Assets with a defined unit size are
       divided into n = ceil(C / U) equal units, where C is overall capacity and U is unit_size
       (i.e. rounding up the number of units, which may result in a total capacity greater than C, if
       C is not an exact multiple of U).
diff --git a/src/model/parameters.rs b/src/model/parameters.rs
diff --git a/src/simulation/investment.rs b/src/simulation/investment.rs
