-
Notifications
You must be signed in to change notification settings - Fork 8
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
Additions to the documentation #39
Additions to the documentation #39
Conversation
for more information, see https://pre-commit.ci
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Few initial comments, very great work!!!
.. code:: yaml | ||
|
||
countries: ["NG"] | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see this is the copy and paste from pypsa-earth; have you tried to follow the procedure to see if it works for -distribution?
In the short tutorial, if tutorial=true, only NG,BJ,BW and MA are supported. this should be mentioned.
Moreover, there is the need to specify the microgrid to consider using the microgrid_list option
Probably, it may be good to have this customization generally applicable to any country; in that case we should specify to make sure tutorial=false in config.yaml
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do you think if i change this section in this way? ( I have tried to write it in such a way that as soon as the tool is working for all countries it will be sufficient to make minor changes to the text )
Specify the country of interest:
Pypsa-Distribution is a tool under development, how soon it will be possible to use it for the study and simulation of microgrids in all countries.
Selection of the country of interest will be possible using the "coutries" argument at the top of the config file.
.. code:: yaml
countries: ["NG"]
Please note,before proceeding, a premise must be made: in analogy with Pypsa-Earth, the simulation will be available in "tutorial" mode and "full" mode.
The tutorial mode is selectable by placing within the config file:
. code:: yaml
tutorial: true
It allows for faster simulation with less data, so that new users can become familiar with the code without running overly heavy simulations. As with Pypsa-Earth, simulation in tutorial mode will be made possible for a small number of countries ( Nigeria, Benin, Botswana, and Morocco).
To perform simulation of other countries it will be necessary to set:
. code:: yaml
tutorial: false
And run a full simulation.
At the current state of development Pypsa-Distribution is able to run simulations in tutorial mode on Nigeria, but the potential of the tool will be extended as soon as possible.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, but at the line "Selection of the country of interest will be possible using the "coutries" argument at the top of the config file.", I'd add "For the quick tutorial, "NG, BW, BJ and MA" are supported with the tutorial mode; for the full model or other region, please refer to {...REF}"
|
||
.. code:: yaml | ||
|
||
countries: ["KE"] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Attention: it would be better to keep the short_tutorial for only the tutorial cases. So, suggest here to keep only one of them, and for other region, please refer to the non-tutorial case.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perfect, I could remove this part ( from " run a different case study" ) and keep it to generate ( possibly later when the run for other configurations is properly executable) , another section in which to explain the simpler settings for running the run for another case study (?)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes :) but please add a note to refer to the other section if the reader needs to do that
I see there are no updates here; we can discuss later on it :) |
Changes proposed in this Pull Request
The changes proposed in this pull request are related to documentation.
On the pypsa-earth line I have: