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

Specifications in documentation : difficulty_levels and GridStateFromFileWithForecasts #639

Open
mariegirod opened this issue Sep 25, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@mariegirod
Copy link

Documentation issue description

Hello,
There are two points in the documentation that could be clearer.

  1. What parameters should be in the difficulty_levels.json file?

  2. The description of the class grid2op.Chronics.GridStateFromFileWithForecasts is as follows: "Forecast are also read from a file. For this class, only 1 forecast per timestep is read. The “forecast” present in the file at row $i$ is the one available at the corresponding time step, so valid for the grid state at the next time step."

When you say there is 1 forecast per timestep, do you mean there is one forecast timestep or one forecast file with possibly several timesteps?

Suggested modifications

For issue 1, I would suggest including an example of a difficulty_levels.json file.
For issue 2, it would be useful to clarify whether the forecast for separate timesteps are read in separate files, or if forecasts for all timesteps are in the same file?

Thank you.

@mariegirod mariegirod added the documentation Improvements or additions to documentation label Sep 25, 2024
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

No branches or pull requests

1 participant