calliope-project / calliope

A multi-scale energy systems modelling framework
https://www.callio.pe
Apache License 2.0
287 stars 93 forks source link

Update math docs and handling of missing data #563

Closed brynpickering closed 7 months ago

brynpickering commented 7 months ago

Fixes issue mentioned in #559 w.r.t. information provided in the pre-defined math docs.

Summary of changes in this pull request:

TODO:

Reviewer checklist:

codecov[bot] commented 7 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (4e77873) 95.77% compared to head (69bccd9) 95.83%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #563 +/- ## ========================================== + Coverage 95.77% 95.83% +0.05% ========================================== Files 24 24 Lines 3574 3599 +25 Branches 780 719 -61 ========================================== + Hits 3423 3449 +26 Misses 86 86 + Partials 65 64 -1 ``` | [Files](https://app.codecov.io/gh/calliope-project/calliope/pull/563?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=calliope-project) | Coverage Δ | | |---|---|---| | [src/calliope/backend/backend\_model.py](https://app.codecov.io/gh/calliope-project/calliope/pull/563?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=calliope-project#diff-c3JjL2NhbGxpb3BlL2JhY2tlbmQvYmFja2VuZF9tb2RlbC5weQ==) | `97.89% <100.00%> (+0.01%)` | :arrow_up: | | [src/calliope/backend/expression\_parser.py](https://app.codecov.io/gh/calliope-project/calliope/pull/563?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=calliope-project#diff-c3JjL2NhbGxpb3BlL2JhY2tlbmQvZXhwcmVzc2lvbl9wYXJzZXIucHk=) | `97.18% <100.00%> (+0.02%)` | :arrow_up: | | [src/calliope/backend/latex\_backend\_model.py](https://app.codecov.io/gh/calliope-project/calliope/pull/563?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=calliope-project#diff-c3JjL2NhbGxpb3BlL2JhY2tlbmQvbGF0ZXhfYmFja2VuZF9tb2RlbC5weQ==) | `97.76% <100.00%> (+1.52%)` | :arrow_up: | | [src/calliope/backend/parsing.py](https://app.codecov.io/gh/calliope-project/calliope/pull/563?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=calliope-project#diff-c3JjL2NhbGxpb3BlL2JhY2tlbmQvcGFyc2luZy5weQ==) | `97.76% <100.00%> (-0.90%)` | :arrow_down: | | [src/calliope/backend/pyomo\_backend\_model.py](https://app.codecov.io/gh/calliope-project/calliope/pull/563?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=calliope-project#diff-c3JjL2NhbGxpb3BlL2JhY2tlbmQvcHlvbW9fYmFja2VuZF9tb2RlbC5weQ==) | `95.41% <100.00%> (+0.45%)` | :arrow_up: | | [src/calliope/backend/where\_parser.py](https://app.codecov.io/gh/calliope-project/calliope/pull/563?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=calliope-project#diff-c3JjL2NhbGxpb3BlL2JhY2tlbmQvd2hlcmVfcGFyc2VyLnB5) | `97.29% <100.00%> (+0.02%)` | :arrow_up: |
irm-codebase commented 7 months ago

Fantastic addition! Adding a list of the constraints where a parameter is used is a really good idea. However, it seems like some math is broken in the new parameters section. Here's an example: image

brynpickering commented 7 months ago

OK great, that was a missing $ in the string. If you find any others, do flag them!

brynpickering commented 7 months ago

Chosen a subset of parameters listed in the inter-cluster storage docs. Also updated links in docs to prefer linking to the math docs parameter list rather than the schema. Annoyingly, because the math docs are auto-generated it isn't possible to link directly to the Parameters anchor in the math docs.