Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs/Improvement of documentation and library #29

Merged
merged 15 commits into from
Oct 16, 2024
Merged

Conversation

JulStraus
Copy link
Member

This PR follows similar PRs in EnergyModelsBase and EnergyModelsRenewableProducers and EnergyModelsCO2. It is essentially an improvement on the documentation with a mathematical description of the individual concepts.

The main aim is to:

  1. provide an improved description of the individual areas and transmission modes, specifically regarding the underlying math and requirements for input,
  2. restructuring the library to reduce the individual page lengths.

The investment tests are furthermore included in the CI.

@JulStraus JulStraus added the documentation Improvements or additions to documentation label Oct 15, 2024
@JulStraus
Copy link
Member Author

The tests are currently failing as we have not yet registered the version of EMB which allows for deactivating all tests in Pull request 39. However, it is still possible to check for typos in the documentation.

docs/src/area_mode/area.md Outdated Show resolved Hide resolved
docs/src/area_mode/area.md Outdated Show resolved Hide resolved
docs/src/area_mode/area.md Outdated Show resolved Hide resolved
docs/src/area_mode/corridor.md Outdated Show resolved Hide resolved
docs/src/area_mode/corridor.md Outdated Show resolved Hide resolved
while bidirectional transport utilize again the variables ``\texttt{trans\_pos}[tm, t]`` and ``\texttt{trans\_neg}[tm, t]`` as introduced above:

```math
\texttt{emissions\_trans}[tm, t, p_{em}] = emission(tm, p_{em}, t) \times \left(\texttt{trans\_pos}[tm, t] + \texttt{trans\_neg}[tm, t]\right)
Copy link
Member

Choose a reason for hiding this comment

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

In a update of the bi-directional flow equations:
here we should also withdraw 0.5*loss(tm, t) form the sum of trans_pos + trans_neg

src/model.jl Outdated Show resolved Hide resolved
src/structures/area.jl Outdated Show resolved Hide resolved
src/structures/area.jl Outdated Show resolved Hide resolved
src/structures/mode.jl Outdated Show resolved Hide resolved
Copy link
Member Author

@JulStraus JulStraus left a comment

Choose a reason for hiding this comment

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

I will incorporate some of the changes, the rest I would leave for a separate Issue/PR. Changing the behavior on loss calculations would in my opinion correspond to a major release, even if it is not breaking backwards compatibility.


!!! todo "Loss calculations"
It looks to me that the loss calculations are not equivalent.
We have to change that.
Copy link
Member Author

Choose a reason for hiding this comment

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

I would see that as a separate Issue/PR.

```math
\begin{aligned}
\texttt{trans\_opex\_var}[tm, t_{inv}] = \sum_{t \in t_{inv}} & opex\_var(tm, t) \times \\ &
\left(\texttt{trans\_pos}[tm, t] + \texttt{trans\_neg}[tm, t]\right) \times \\ &
Copy link
Member Author

Choose a reason for hiding this comment

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

We can discuss that in more detail in a separate Issue/PR

src/structures/area.jl Outdated Show resolved Hide resolved
src/structures/area.jl Outdated Show resolved Hide resolved
- Removed check_any_data for EMB (to be included in separate PR)
- Fixed docstring for `GeoAvailability`
@JulStraus JulStraus merged commit 03fbcfb into main Oct 16, 2024
5 checks passed
@JulStraus JulStraus deleted the docs/modes_lib branch October 16, 2024 10:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants