Skip to content

(PR51) Documentation/Investment Tutorial#135

Open
GuillaumeMaistre wants to merge 41 commits into
developfrom
documentation/pr51-investment-tutorial
Open

(PR51) Documentation/Investment Tutorial#135
GuillaumeMaistre wants to merge 41 commits into
developfrom
documentation/pr51-investment-tutorial

Conversation

@GuillaumeMaistre
Copy link
Copy Markdown
Collaborator

@GuillaumeMaistre GuillaumeMaistre commented May 19, 2026

Process ID

Process:
DOC-02

Description

Handle the issue #143
Need to add e2e tests following #126

Impact Analysis

yes, it adds e2e tests

Checklist

  • E2E tests pass (or confirmed not affected)
  • Library version bumped if library changed (library.version in libraries/<library>.yml)
  • Changelog entry added if library changed (libraries/CHANGELOG-<library>.md)
  • Release notes entry added if language-level change (doc/0_Home/4_release_notes.md)
  • Compatibility matrix updated if applicable (COMPATIBILITY.md)
  • Documentation updated or confirmed up to date
  • AGENTS.md reviewed for impact and updated if needed

@GuillaumeMaistre GuillaumeMaistre added documentation Improvements or additions to documentation rtei labels May 19, 2026
@GuillaumeMaistre GuillaumeMaistre changed the title [WIP] (PR51) Documentation/Investment Tutorial (PR51) Documentation/Investment Tutorial May 21, 2026
@GuillaumeMaistre GuillaumeMaistre requested a review from aoustry May 21, 2026 15:02
Copy link
Copy Markdown
Collaborator

@aoustry aoustry left a comment

Choose a reason for hiding this comment

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

Good job, I think there is still some room of improvements to have something really nice!

Please think of adding e2e tests, as for the other tutorials.

id: investment_library
description: "Library for the investment tutorial jupyter notebook"


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.

Remove from the investment_tutorial_library the models that are not used in the system please.

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.

done

description: A port that transfers quantities of gas emissions.
fields:
- id: co2

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.

In this tutorial, it could be good to also invest on storage capacities. In the modelling, you can have a duration parameters that links the injection/withdrawal capacity with the reservoir capacity (ex: reservoir capacity = duration *injection_capacity; all capacities are variables)

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.

In the tutorial you can have first a case where you invest only on the generation unit, and then a second case where you invest on both -> normally, when you have the possibility to invest also on the battery, this should reduce the optimal investment in the generation capacity.

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.

done

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.

Please add more timesteps : 24 for instance, for one days.

You can explain in the description of the tutorial that the MC scenarios are "representative days".

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.

Also the 24 hours timeseries should look somehow "realistic"

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 used the 7 days TS from the tutorial about unit commitment as a base for these TS

Comment on lines +25 to +32
"We use **3 scenarios** and **4 timesteps**:\n",
"\n",
"| Scenario | Load level | Renewable share | Without investment |\n",
"|---|---|---|---|\n",
"| **S1** — Favourable | Low (190–220 MW) | High (100–140 MW) | Adequate — no problem |\n",
"| **S2** — Critical | High (450–500 MW) | Low (20–40 MW) | ~220–275 MW unsupplied per timestep |\n",
"| **S3** — Intermediate | Medium (310–360 MW) | Medium (60–90 MW) | ~20–90 MW unsupplied per timestep |\n",
"\n",
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.

As explained the scenarios should be at least days.

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.

done

Comment on lines +34 to +48
"Load (demand in MW) : \n",
"| S1 | S2 | S3 |\n",
"| --- | --- | --- |\n",
"| 200 | 450 | 320 |\n",
"| 210 | 480 | 340 |\n",
"| 190 | 460 | 310 |\n",
"| 220 | 500 | 360 |\n",
"\n",
"Renewable production (in MW) :\n",
"| S1 | S2 | S3 |\n",
"| --- | --- | --- |\n",
"| 120 | 30 | 80 |\n",
"| 100 | 20 | 60 |\n",
"| 140 | 40 | 90 |\n",
"| 110 | 25 | 70 |\n",
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.

You should present this in graphs

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.

added

"\n",
"The study folder is inside the [`Tutorial_3_Investment/`](../Tutorial_3_Investment/Tutorial_Investment/ -TODO link to zip folder)\n",
"\n",
"The `basic-models-library` was used as a basis for creating the `investment_library.yml` where the new model **candidate_generator** was added.\n",
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 sentence should be removed: it is not useful to explain how you generate this lib. you just mention here what is the library you're using, and give a link to the yml file.

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.

deleted

},
"metadata": {
"image/png": {
"alt": "Stacked bar charts showing dispatch (existing thermal, candidate thermal, renewable) for each of the 3 scenarios across 4 timesteps."
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.

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.

  • explanations added
  • plots changed for stack plots

- id: investment_cost
time-dependent: false
scenario-dependent: false
value: 50 # €/MW
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.

The investment costs are derived from the annual payments, converted to a daily basis (given that the time horizon for the problems is one day); I propose using €250/MW.day (this corresponds to € 91,250/MW.year)

So use the numerical value 250 and give my explanations in #comments.

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.

added

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 rtei

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants