Skip to content

New investment docs#1416

Merged
tsmbland merged 11 commits into
mainfrom
investment_docs
Jul 17, 2026
Merged

New investment docs#1416
tsmbland merged 11 commits into
mainfrom
investment_docs

Conversation

@tsmbland

@tsmbland tsmbland commented Jul 13, 2026

Copy link
Copy Markdown
Collaborator

Description

Brings the Investment docs in line with the current approach. Hopefully it's all self explanatory!

Fixes #1164
Fixes #1270

Type of change

  • Bug fix (non-breaking change to fix an issue)
  • New feature (non-breaking change to add functionality)
  • Refactoring (non-breaking, non-functional change to improve maintainability)
  • Optimization (non-breaking change to speed up the code)
  • Breaking change (whatever its nature)
  • Documentation (improve or add documentation)

Key checklist

  • All tests pass: $ cargo test
  • The documentation builds and looks OK: $ cargo doc
  • Update release notes for the latest release if this PR adds a new feature or fixes a bug
    present in the previous release

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

@codecov

codecov Bot commented Jul 13, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.79%. Comparing base (9f3e1fe) to head (4735a19).
⚠️ Report is 14 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@tsmbland tsmbland mentioned this pull request Jul 14, 2026
11 tasks
Base automatically changed from second_new_tranching_approach to main July 14, 2026 14:13
@tsmbland
tsmbland marked this pull request as ready for review July 15, 2026 10:40
Copilot AI review requested due to automatic review settings July 15, 2026 10:40

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md to 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.md to 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.

Comment thread docs/model/investment.md Outdated

@dc2917 dc2917 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've just noted a couple of small potential improvements, and some places where things aren't entirely clear

Comment thread docs/model/investment.md Outdated
Comment thread docs/model/investment.md Outdated
Comment thread docs/model/investment.md Outdated
Comment thread docs/model/investment.md Outdated
Comment thread docs/model/investment.md Outdated

@dalonsoa dalonsoa left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks really good and clear, but I've some comments on areas that need clarification.

Comment thread docs/model/investment.md
Comment thread docs/model/investment.md Outdated
Comment thread docs/model/investment.md
Comment thread docs/model/investment.md Outdated
Comment thread docs/model/investment.md Outdated
@tsmbland
tsmbland requested review from dalonsoa and dc2917 July 17, 2026 10:55

@dalonsoa dalonsoa left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, subject to the explanations in some of the comments that would require to revisit this in the future.

@dc2917 dc2917 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One tiny fix but otherwise this all looks good, thanks for addressing the suggestions!

Comment thread docs/model/investment.md Outdated
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}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
\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

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did try this but weirdly it broke the rendering (at least on my machine). A bit baffling...

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

\text{Demand}\_t seems to be the answer

@tsmbland
tsmbland merged commit ebd2bff into main Jul 17, 2026
7 of 8 checks passed
@tsmbland
tsmbland deleted the investment_docs branch July 17, 2026 13:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation on tranches is incorrect Description of tranching in docs doesn't match what we do

4 participants