Release notes for v2.2.0 - #1524
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1524 +/- ##
=======================================
Coverage 90.85% 90.85%
=======================================
Files 61 61
Lines 9039 9039
Branches 9039 9039
=======================================
Hits 8212 8212
Misses 508 508
Partials 319 319 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
⚠️ Performance Alert ⚠️
Possible performance regression was detected for benchmark.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.30.
| Benchmark suite | Current: d938184 | Previous: 7cd741d | Ratio |
|---|---|---|---|
example_run/muse1_default example |
397501924 ns |
296044869 ns |
1.34 |
This comment was automatically generated by workflow using github-action-benchmark.
There was a problem hiding this comment.
🟡 Changes recommended
It introduces objective doc issues (typos/future-dated release text) and contains v2.2.0 site links that will fail the existing Lychee link-check CI until the v2.2.0 docs are published or excluded.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Adds documentation for the v2.2.0 release by introducing a new release-notes page and wiring it into the docs navigation, while clearing out the “upcoming” release notes in preparation for the next cycle.
Changes:
- Add
docs/release_notes/v2.2.0.mdwith detailed v2.2.0 release notes and link references. - Link v2.2.0 release notes from the docs summary and release-notes index pages.
- Reset
docs/release_notes/upcoming.mdcontent (and reformat benchmark JSON data).
File summaries
| File | Description |
|---|---|
| docs/SUMMARY.md | Adds v2.2.0 entry to the documentation navigation. |
| docs/release_notes/v2.2.0.md | Introduces the v2.2.0 release notes content and documentation links. |
| docs/release_notes/upcoming.md | Clears prior “upcoming” notes to start the next release cycle. |
| docs/release_notes/README.md | Adds v2.2.0 entry to the release notes index. |
| benches/benchmark-data.json | Large formatting/indentation-only change to benchmark data. |
Review details
- Files reviewed: 4/5 changed files
- Comments generated: 5
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| { | ||
| "lastUpdate": 1788338865130, | ||
| "repoUrl": "https://github.com/EnergySystemsModellingLab/MUSE2", | ||
| "entries": { | ||
| "Benchmark": [ | ||
| { | ||
| "commit": { | ||
| "author": { | ||
| "email": "t.bland@imperial.ac.uk", | ||
| "name": "Tom Bland", | ||
| "username": "tsmbland" | ||
| }, | ||
| "committer": { | ||
| "email": "noreply@github.com", | ||
| "name": "GitHub", | ||
| "username": "web-flow" | ||
| }, | ||
| "distinct": true, | ||
| "id": "849164f50fd97a3388189aee2b020d8e4c594619", | ||
| "message": "Merge pull request #1516 from EnergySystemsModellingLab/allow_push_main\n\nUse PR instead of direct push to main", | ||
| "timestamp": "2026-09-01T10:45:49+01:00", | ||
| "tree_id": "f4e331cadaf5c3b9c48399c16a7484e673f3283e", | ||
| "url": "https://github.com/EnergySystemsModellingLab/MUSE2/commit/849164f50fd97a3388189aee2b020d8e4c594619" | ||
| }, | ||
| "date": 1788256182014, | ||
| "tool": "customSmallerIsBetter", | ||
| "benches": [ | ||
| { | ||
| "name": "example_run/circularity example", | ||
| "value": 414093669, | ||
| "unit": "ns" | ||
| }, | ||
| { | ||
| "name": "example_run/missing_commodity example", | ||
| "value": 224283879.25, | ||
| "unit": "ns" | ||
| }, | ||
| { | ||
| "name": "example_run/muse1_default example", | ||
| "value": 257200258.5, | ||
| "unit": "ns" | ||
| }, | ||
| { | ||
| "name": "example_run/simple example", | ||
| "value": 82232509.625, | ||
| "unit": "ns" | ||
| }, | ||
| { | ||
| "name": "example_run/two_outputs example", | ||
| "value": 397768111.5, | ||
| "unit": "ns" | ||
| }, | ||
| { | ||
| "name": "example_run/two_regions example", | ||
| "value": 444982302.5, | ||
| "unit": "ns" | ||
| }, | ||
| { | ||
| "name": "select_best_assets_parallel/01", | ||
| "value": 7184719.770833334, | ||
| "unit": "ns" | ||
| }, | ||
| { | ||
| "name": "select_best_assets_parallel/05", | ||
| "value": 21415495.111111112, | ||
| "unit": "ns" | ||
| }, | ||
| { | ||
| "name": "select_best_assets_parallel/10", | ||
| "value": 35291724, | ||
| "unit": "ns" | ||
| }, | ||
| { | ||
| "name": "select_best_assets_parallel/15", | ||
| "value": 51844114.66666667, | ||
| "unit": "ns" | ||
| }, | ||
| { | ||
| "name": "select_best_assets_parallel/20", | ||
| "value": 66430136.16666667, | ||
| "unit": "ns" | ||
| }, | ||
| { | ||
| "name": "select_best_assets_sequential/01", | ||
| "value": 7215430.817307692, | ||
| "unit": "ns" | ||
| }, | ||
| { | ||
| "name": "select_best_assets_sequential/05", | ||
| "value": 34758098.5, | ||
| "unit": "ns" | ||
| }, | ||
| { | ||
| "name": "select_best_assets_sequential/10", | ||
| "value": 69328321.66666666, | ||
| "unit": "ns" | ||
| }, | ||
| { | ||
| "name": "select_best_assets_sequential/15", | ||
| "value": 103927071, | ||
| "unit": "ns" | ||
| }, | ||
| { | ||
| "name": "select_best_assets_sequential/20", | ||
| "value": 138376641.75, | ||
| "unit": "ns" | ||
| } | ||
| "lastUpdate": 1788338865130, | ||
| "repoUrl": "https://github.com/EnergySystemsModellingLab/MUSE2", | ||
| "entries": { | ||
| "Benchmark": [ | ||
| { |
There was a problem hiding this comment.
Done by the bot after I merged main. See #1525. Annoying, but CBA to split this into another PR.
|
Tests failing on Windows is due to #1523 - to fix separately |
| Please be aware that there are some breaking changes in this release, which may require you to | ||
| update the input files of any existing models. We have tried to outline these in the "Breaking | ||
| changes" section below, but please do get in touch if you have any issues adapting models to the new | ||
| version. |
There was a problem hiding this comment.
Do you have an established way for users to get in touch? E.g. GitHub issues? Might be worth mentioning (unless it's obvious)
There was a problem hiding this comment.
In practice this is just Adam sending me a message on Teams. Once we have more users we can think about this. E.g for MUSE1 there's the Google group, although that's not as active as it used to be
dalonsoa
left a comment
dalonsoa
left a comment
There was a problem hiding this comment.
Nothing to add. This looks great!
| mothballing and decommissioning has been modified or fundamentally changed, in many cases to address | ||
| issues in the model formulation brought to light through rigorous testing and assessment of the | ||
| software in action. In many ways this is not just a software update, but a research update to what | ||
| is very much a live and evolving project. |
| In addition, investment appraisal is now parallelised over candidate assets, which may improve | ||
| performance, particularly for large models run on multi-core machines ([#1466]). | ||
|
|
||
| ### Divisible assets and tranching |
There was a problem hiding this comment.
This section is super clear in explaining tranches 👍
Co-authored-by: Dan Cummins <45606273+dc2917@users.noreply.github.com>
Description
Release notes for v2.2.0. Hopefully this also serves as a useful report of progress for this engagement. As with all release notes, it focusses on changes that are relevant for users, rather than purely developer-facing changes (not that these aren't also numerous and important!).
Left to do before making a release:
validate_capacity_growth_limit_warningis non-deterministic #1523I've had to ignore the v2.2.0 docs from the link checker, as this version of the docs doesn't exist yet, but will remove this after making the release. A bit of a chicken and egg situation - not sure if there's a better solution here.
Tentatively will put this out tomorrow.
Fixes #1499
Type of change
Key checklist
$ cargo test$ cargo docpresent in the previous release
Further checks