New investment docs#1416
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.79% -0.02%
==========================================
Files 59 59
Lines 8384 8375 -9
Branches 8384 8375 -9
==========================================
- Hits 7278 7269 -9
Misses 790 790
Partials 316 316 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
dc2917
left a comment
There was a problem hiding this comment.
I've just noted a couple of small potential improvements, and some places where things aren't entirely clear
dalonsoa
left a comment
There was a problem hiding this comment.
This looks really good and clear, but I've some comments on areas that need clarification.
dalonsoa
left a comment
There was a problem hiding this comment.
LGTM, subject to the explanations in some of the comments that would require to revisit this in the future.
dc2917
left a comment
There was a problem hiding this comment.
One tiny fix but otherwise this all looks good, thanks for addressing the suggestions!
| that with the highest load factor. The size of this tranche is the overall peak demand divided by | ||
| an input parameter (which can vary between 2 and 6). This assumption should be revisited! | ||
| \\[ | ||
| \text{DLC} = \max_{\text{selection}} \frac{\sum_{t \in \text{selection}} Demand_t} |
There was a problem hiding this comment.
| \text{DLC} = \max_{\text{selection}} \frac{\sum_{t \in \text{selection}} Demand_t} | |
| \text{DLC} = \max_{\text{selection}} \frac{\sum_{t \in \text{selection}} \text{Demand}_t} |
for consistency with equation above
There was a problem hiding this comment.
I did try this but weirdly it broke the rendering (at least on my machine). A bit baffling...
There was a problem hiding this comment.
\text{Demand}\_t seems to be the answer
Description
Brings the Investment docs in line with the current approach. Hopefully it's all self explanatory!
Fixes #1164
Fixes #1270
Type of change
Key checklist
$ cargo test$ cargo docpresent in the previous release
Further checks