New investment docs#1416
Open
tsmbland wants to merge 8 commits into
Open
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1416 +/- ##
=======================================
Coverage 86.80% 86.80%
=======================================
Files 59 59
Lines 8384 8384
Branches 8384 8384
=======================================
Hits 7278 7278
Misses 790 790
Partials 316 316 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the investment documentation to match the current MUSE2 investment/appraisal implementation, addressing the tranching/asset-sizing mismatch described in #1164.
Changes:
- Rewrites
docs/model/investment.mdto describe the current investment order, candidate sizing (capacity_limit_factor), demand-limiting capacity, mini dispatch optimisation, and metric calculations (LCOX/NPV). - Updates the workflow docs link target in
docs/model/README.mdto point to the new “Metric Calculation” section.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/model/README.md | Updates the reference link for “investment appraisal tools” to the new section anchor. |
| docs/model/investment.md | Substantial rewrite to align the investment/appraisal documentation with the current code path (capacity sizing, constraints, optimisation, metrics). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Brings the Investment docs in line with the current approach. Hopefully it's all self explanatory!
Fixes #1164
Type of change
Key checklist
$ cargo test$ cargo docpresent in the previous release
Further checks