Open pz-max opened 1 year ago
Completely agree. I add below some preliminary comments for revision:
Feel free all to add and revise :)
Moreover, we shall improve the contributing section by revising the pre-commit part and clarify how to use that.
Moreover, we shall improve the contributing section by revising the pre-commit part and clarify how to use that.
Added a point to https://github.com/pypsa-meets-earth/documentation/issues/17 to keep track of the hints we have :)
@yerbol-akhmetov and @Netotse , thanks for being interested in this interesting issue, with lots of opportunities to learn and contribute :D
I'll draft here few proposals to break down the problem above and start with interesting and catchy tasks :)
So, I think it is very important to:
To actually propose a new version of any of the documentation file, you shall create a PR to this repository where you change the corresponding .rst file available in the doc folder. In the above, references to the files are provided. To do so, you shal "clone" the repository of github, do:
Happy to add details :D Moreover @ekatef expressed interests, feel free to support anytime :) likewise @pz-max
Thanks @davide-f ,
I agree with your comments and have started implementing but I think to be friendly to the absolute noob, the begining should be the software hits portion, we can put a link to it in the installation page if the team feel most of the users will be more advanced but it would be good to start by:
what do you think?
As a new user I think that this improvement could contribute to reduce first steps for participate in pypsa-earth!
I add to the discussion that it is important to add a description on how to install the pre-commit:
Thanks @davide-f ,
I agree with your comments and have started implementing but I think to be friendly to the absolute noob, the begining should be the software hits portion, we can put a link to it in the installation page if the team feel most of the users will be more advanced but it would be good to start by:
- Identifying hardware requirements(it's at the bottom of the page, i'd like to move it to the top)
- List out the different software packages required to run pypsa meets earth
- Since I've seen questions about setting up vs code, it would be good to also include the link to the video @pz-max posted in the support channel.
what do you think?
Feel free to revise as you best think, I highly like the proposals :D as also confirmed by @TomFer97 :) Sorry but I've been on holiday recently...
I add to the discussion that it is important to add a description on how to install the pre-commit:
* in vscode, view-Command palette->Python: Select Intepreter-> pypsa-earth environment * once that is done, in the prompt of commands, digit "pre-commit install" * before commiting, may be good to execute "pre-commit run --all" to make sure the code is compliant to pre-commit
Hi David,
I will reach out to you on discord for more info on this, when I open the command palette, I do not see the pypsa-earth environment in the select interpreter section
I add to the discussion that it is important to add a description on how to install the pre-commit:
* in vscode, view-Command palette->Python: Select Intepreter-> pypsa-earth environment * once that is done, in the prompt of commands, digit "pre-commit install" * before commiting, may be good to execute "pre-commit run --all" to make sure the code is compliant to pre-commit
Hi David,
I will reach out to you on discord for more info on this, when I open the command palette, I do not see the pypsa-earth environment in the select interpreter section
Hello! Just to share, during the meeting, we discussed about this and now the problem is solved, right?
Adding to the points above, there is also a need to update documentation on data management. Currently, the docs suggest to build a custom cutout, while currently we still have a number of pre-built cutouts which can be the first choice to avoid all the issue with Copernicus API registration.
Hello @yerbol-akhmetov, hello @Netotse, as discussed yesterday, documentation update is getting crucial. Thank you for pushing this issue!
@Netotse your ideas on documentation are very much appreciated. Do you have any updates? Let me know please how can we support your work.
@yerbol-akhmetov thanks a lot for suggesting help. Please feel free to open a PR. Happy to assist, if needed.
Hi, I have created a draft PR (https://github.com/pypsa-meets-earth/pypsa-earth/pull/918). Currently working on installation section. I am using the reStructuredText plugin to preview the changes in .rst
file. Although it works fine, in some cases it does not show the final version as it will be in documentation website. Could you please recommend any other plugins?
Hi, I have created a draft PR (#918). Currently working on installation section. I am using the reStructuredText plugin to preview the changes in
.rst
file. Although it works fine, in some cases it does not show the final version as it will be in documentation website. Could you please recommend any other plugins?
Hey @yerbol-akhmetov, awesome! Thanks a lot for pushing this.
Have you tried to use shinx itself to build the documentation locally? To do so, you would need to install the dedicated docs environment which contains shpinx, and run sphinx with make html
. More detailed instructions are in How to docs
: https://pypsa-earth.readthedocs.io/en/latest/tutorial.html#compile-the-documentation-locally
Copying here the ideas generated during the developers meeting and a discussion on Discord:
Full model
section needs more structurepypsa-earth
videos can be added to supplement PyPSA-Eur video.Thanks a lot @pz-max and @yerbol-akhmetov for the amazing discussion. Obviously, feel free to correct me and add points to the list.
In the documentation, better in the full model representation, it would be important to add a section with a procedure to validate the model. Many users need to validate their model and having a guidance on how to do that would be quite good. FYI @yerbol-akhmetov and @ekatef
In the documentation, better in the full model representation, it would be important to add a section with a procedure to validate the model. Many users need to validate their model and having a guidance on how to do that would be quite good. FYI @yerbol-akhmetov and @ekatef
Absolutely agree. Validation is definitely a crucial part right now, and would be great to facilitate it as much as we can. Currently, we have some cumulative experience of validation for a number of use cases, although it could be great to harmonise that. Mainly, the notebooks have been used for that. A list of the relevant notebooks may look as follows: 1) installed generation capacity; 2) electricity demand; 3) topology of the power transmission system for different voltages.; 4) power dispatch -- the final plot may be handy in sample_network_analysis notebook.
There is also an example of "holistic" validation approaches which relate to all the model components for Nigeria and Namibia.
An update regarding a validation methodology: that is absolutely needed to include an approach to calculate the overall energy demand. That is one of the key steps of the validation, while that is not obvious at all how to account for the time step.
As a reminder, the needed magic looks like follows:
overall_load = (
n.loads_t.p_set
.multiply(n.snapshot_weightings.generators, axis=0)
.sum()
.sum()
)
Just want to add a small comment: The current link to IRENA's data in the "Full Model: Where to look for reference data" section leads to an error page. It's possible to navigate back to the main page from there. To enhance user experience, it would be better to update the link to the IRENA Statistics Main Page https://pxweb.irena.org/pxweb/en/.
Just want to add a small comment: The current link to IRENA's data in the "Full Model: Where to look for reference data" section leads to an error page. It's possible to navigate back to the main page from there. To enhance user experience, it would be better to update the link to the IRENA Statistics Main Page https://pxweb.irena.org/pxweb/en/.
Hey @swaechchha, great, thanks a lot for the suggested fix 🙂 I can't suggest you to open a PR as there is still a big PR is under review to improve Full Model
section... But we are happy to count you as a contributor, anyway!
My feeling is that this issue is completely covered with #918 and #959. Can we probably close it? @pz-max
From Discord. I feel our documentation needs some restructuring:
Problem: The installation section & tutorial sections motivates people to create a config.yaml from the config.default.yaml that often leads to issues. Sometimes we refer people to the tutorial but what we mean is the "getting started" section. Getting started and tutorial should be put together.