calliope-project / calliope

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

Documentation updates #559

Closed brynpickering closed 4 months ago

brynpickering commented 5 months ago

Fixes #555

Changes made in this Pull Request

Reviewer checklist:

codecov[bot] commented 5 months ago

Codecov Report

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

Comparison is base (fd2917b) 95.76% compared to head (39861c3) 95.76%.

:exclamation: Current head 39861c3 differs from pull request most recent head eb953af. Consider uploading reports for the commit eb953af to get more accurate results

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #559 +/- ## ======================================= Coverage 95.76% 95.76% ======================================= Files 24 24 Lines 3566 3566 Branches 777 711 -66 ======================================= Hits 3415 3415 Misses 86 86 Partials 65 65 ``` | [Files](https://app.codecov.io/gh/calliope-project/calliope/pull/559?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/559?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=calliope-project#diff-c3JjL2NhbGxpb3BlL2JhY2tlbmQvYmFja2VuZF9tb2RlbC5weQ==) | `97.87% <100.00%> (ø)` | | | [src/calliope/backend/helper\_functions.py](https://app.codecov.io/gh/calliope-project/calliope/pull/559?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=calliope-project#diff-c3JjL2NhbGxpb3BlL2JhY2tlbmQvaGVscGVyX2Z1bmN0aW9ucy5weQ==) | `97.75% <ø> (ø)` | | | [src/calliope/backend/latex\_backend\_model.py](https://app.codecov.io/gh/calliope-project/calliope/pull/559?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=calliope-project#diff-c3JjL2NhbGxpb3BlL2JhY2tlbmQvbGF0ZXhfYmFja2VuZF9tb2RlbC5weQ==) | `96.24% <ø> (ø)` | | | [src/calliope/model.py](https://app.codecov.io/gh/calliope-project/calliope/pull/559?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=calliope-project#diff-c3JjL2NhbGxpb3BlL21vZGVsLnB5) | `93.65% <100.00%> (ø)` | |
brynpickering commented 5 months ago

@irm-codebase and @sjpfenninger, ready for review.

@irm-codebase, you can view the documentation with the PR changes by selecting "Details" of the readthedocs CI check (once it has a green tick mark next to it):

image
irm-codebase commented 5 months ago

Most things look great so far! I only found one funky detail in the schema: image

brynpickering commented 5 months ago

Most things look great so far! I only found one funky detail in the schema: image

Yeah, this is an issue with the upstream dependency. It can't handle "OneOf"/"AnyOf"/"AllOf" schema elements. Another reason perhaps to have a different place to describe parameters.

irm-codebase commented 5 months ago

Most things look great so far! I only found one funky detail in the schema: image

Yeah, this is an issue with the upstream dependency. It can't handle "OneOf"/"AnyOf"/"AllOf" schema elements. Another reason perhaps to have a different place to describe parameters.

In that case I'd recommend to add parameters to the math section (as a table, maybe?). To be honest, I am struggling a bit when translating an older model (the Italy one) to test the pathways because of this, since not all cases are listed.