Skip to content

(PR33) Documentation/Tutorial_1_Unit_Commitment (jupyter notebook)#67

Open
GuillaumeMaistre wants to merge 18 commits intodevelopfrom
documentation/pr33_tutorial_1_jupyter_notebook
Open

(PR33) Documentation/Tutorial_1_Unit_Commitment (jupyter notebook)#67
GuillaumeMaistre wants to merge 18 commits intodevelopfrom
documentation/pr33_tutorial_1_jupyter_notebook

Conversation

@GuillaumeMaistre
Copy link
Collaborator

@GuillaumeMaistre GuillaumeMaistre commented Mar 6, 2026

This PR is under progress and it is not ready to be reviewed

This PR has the following changes :

  • add jupyter notebook using GEMSPy with the unit commitment example

@GuillaumeMaistre GuillaumeMaistre added documentation Improvements or additions to documentation rtei labels Mar 6, 2026
@GuillaumeMaistre
Copy link
Collaborator Author

I added a new environment ; the tutorial_environment containing the needed libraries for running this jupyter notebook (especially GEMSPy)

@GuillaumeMaistre GuillaumeMaistre requested a review from aoustry March 9, 2026 10:02
Copy link
Contributor

@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.

General comments :

  • Could avoid duplicating the library of models ?
  • please rename the folder "QSE_2_Unit_Commitment_tutorial" into "Tutorial_Unit_Commitment_with_GemsPy". In any case, please avoid the reference to the QSE example, a bit misleading.
  • Is it really a need to create an "input" folder in the Github repo, below the aforementioned folder?
  • How can we access to this tutorial from the GEMS website ? Where do you suggest to place the tutorial in the website.
  • Please add "Spilled energy" to the Figures.

Copy link
Contributor

Choose a reason for hiding this comment

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

Why duplicating this file? Couldn't we just use the antares_legacy_models library from the reference folder ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

because we need to add expec function

Copy link
Contributor

Choose a reason for hiding this comment

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

I suggest deleting this file, since the system is created from scratch with GemsPy

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I deleted them

Copy link
Contributor

Choose a reason for hiding this comment

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

I have several comments on the Jupyter Notebook:

  • "This tutorial shows the different commands for using GEMSPy python package for modeling and simulating an Unit Commitment problem." => Add link to GemsPy
  • "We use in this tutorial the library, antares-legacy-models, present in GEMS repo" => "We use in this tutorial the reference library of models called antares-legacy-models"
  • "An area is the central node in the electrical grid where different components connect." => "In the library of models used here, an area is a component representing an energy balance constraint ; several types of components (production, load, storage, links...) might be connected to it."
  • Use € rather than $
  • Labels in the three Graphs "Thermal Generation and... etc" : "Thermal" => "Thermal Generation", "Unsupply" => "Unsupplied" energy.
  • "The wind_farm has a fluctuated power generation" => "The wind_farm has a variable power generation" and same for solar_farm.
  • Results visualization : why load, wind and farm are not printed?
  • "Interconnect Wind Farm and Solar Farm" => "Add Variable Renewable Energies in the system"
  • In the last section, can you add positive starting_cost and fixed_cost to the thermal cluster ? (ex: 20€ and 10 € respectively). This will force the UC to be a bit more realistic. Please don't forget to add this in the description paragraph above the code.
  • nb_units_max_variation_forward and nb_units_max_variation_backward should be equal to nb_units_max for both thermal clusters created.

Copy link
Collaborator Author

@GuillaumeMaistre GuillaumeMaistre Mar 18, 2026

Choose a reason for hiding this comment

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

  • "This tutorial shows the different commands for using GEMSPy python package for modeling and simulating an Unit Commitment problem." => Add link to GemsPy
  • "We use in this tutorial the library, antares-legacy-models, present in GEMS repo" => "We use in this tutorial the reference library of models called antares-legacy-models"
  • "An area is the central node in the electrical grid where different components connect." => "In the library of models used here, an area is a component representing an energy balance constraint ; several types of components (production, load, storage, links...) might be connected to it."
  • Use € rather than $
  • Labels in the three Graphs "Thermal Generation and... etc" : "Thermal" => "Thermal Generation", "Unsupply" => "Unsupplied" energy.
  • "The wind_farm has a fluctuated power generation" => "The wind_farm has a variable power generation" and same for solar_farm.
  • Results visualization : why load, wind and farm are not printed?
  • "Interconnect Wind Farm and Solar Farm" => "Add Variable Renewable Energies in the system"
  • In the last section, can you add positive starting_cost and fixed_cost to the thermal cluster ? (ex: 20€ and 10 € respectively). This will force the UC to be a bit more realistic. Please don't forget to add this in the description paragraph above the code.
  • nb_units_max_variation_forward and nb_units_max_variation_backward should be equal to nb_units_max for both thermal clusters created.

@GuillaumeMaistre
Copy link
Collaborator Author

GuillaumeMaistre commented Mar 18, 2026

General comments :

  • Could avoid duplicating the library of models ?
  • please rename the folder "QSE_2_Unit_Commitment_tutorial" into "Tutorial_Unit_Commitment_with_GemsPy". In any case, please avoid the reference to the QSE example, a bit misleading.
  • Is it really a need to create an "input" folder in the Github repo, below the aforementioned folder?
  • How can we access to this tutorial from the GEMS website ? Where do you suggest to place the tutorial in the website.
  • Please add "Spilled energy" to the Figures.
  • Could avoid duplicating the library of models ? => I have an error by using the new antares-legacy-models library
  • please rename the folder "QSE_2_Unit_Commitment_tutorial" into "Tutorial_Unit_Commitment_with_GemsPy". In any case, please avoid the reference to the QSE example, a bit misleading. => I changed it
  • Is it really a need to create an "input" folder in the Github repo, below the aforementioned folder? => I deleted the inputs/ folder, all the files are in the same dedicated study folder
  • How can we access to this tutorial from the GEMS website ? Where do you suggest to place the tutorial in the website. => I added a link to the jupyter notebook in the getting started section
  • Please add "Spilled energy" to the Figures. => I added them

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