Update documentation for total_capacity_limit - #1529
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1529 +/- ##
=======================================
Coverage 90.95% 90.95%
=======================================
Files 61 61
Lines 9050 9050
Branches 9050 9050
=======================================
Hits 8231 8231
Misses 500 500
Partials 319 319 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
🟡 Changes recommended
The updated docs contain a few concrete clarity/LaTeX issues (allocation wording and equation subscripts) that should be corrected to avoid misleading or incorrectly rendered documentation.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR updates the investment documentation and the process_investment_constraints input schema to describe how total_capacity_limit works, alongside existing addition_limit constraints.
Changes:
- Expanded
docs/model/investment.mdto document bothaddition_limit(new-build) andtotal_capacity_limit(total installed) constraints, including multi-agent scaling. - Updated
schemas/input/process_investment_constraints.yamlto describetotal_capacity_limitand how it is allocated across agents.
File summaries
| File | Description |
|---|---|
| schemas/input/process_investment_constraints.yaml | Updates the schema description/notes for total_capacity_limit. |
| docs/model/investment.md | Adds/expands documentation for investment constraints, including formulas and total capacity limits. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 4
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| \\[ | ||
| \mathrm{MaxInstallableCapacity} = \mathrm{AdditionLimit} \times \Delta_{\mathrm{MSY}} | ||
| \times \mathrm{AgentPortion} | ||
| \mathrm{MaxInstallableCapacity}\_{p,r,y,g} = \mathrm{AdditionLimit}\_{p,r,y} | ||
| \cdot \Delta\_{\mathrm{MSY}} \cdot \mathrm{AgentPortion}\_{c,r,y,g} | ||
| \\] |
There was a problem hiding this comment.
I never understood the deal with underscores, but these do render correctly, and they do not render if I remove the backslashes
There was a problem hiding this comment.
This is because it's latex within markdown, and there's conflicting syntax. Looks good to me as it is.
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: 3726dba | Previous: 7cd741d | Ratio |
|---|---|---|---|
example_run/muse1_default example |
415154604 ns |
296044869 ns |
1.40 |
This comment was automatically generated by workflow using github-action-benchmark.
Description
Update the investment docs and schema to talk about total capacity limits
Fixes #1521
Type of change
Key checklist
$ cargo test$ cargo docpresent in the previous release
Further checks