Attached a couple of general preliminary comments.
It looks like pictures could be improved:
main_project.png has some traces left from the upper part;
aspect ratio of the demo-plots looks suboptimal, and a font size could be probably increased;
I'd suggest to place Using Your Own PyPSA-Earth and Final Step: Connecting PyPSA-Earth-Lit to PyPSA-Earth before Application Architecture, as the architecture is more relevant for the developers, while users may want the continuous tutorial.
What do you think?
My general impression is that README is in fact quite comprehensive documentation. So, absolutely agree with @pz-max that translating it into read-the-docs makes absolutely sense, as apart of the points we discussed, it facilitates navigation through the sections.
Hello @drifter089! Great work :)
Attached a couple of general preliminary comments.
main_project.png
has some traces left from the upper part;Using Your Own PyPSA-Earth
andFinal Step: Connecting PyPSA-Earth-Lit to PyPSA-Earth
beforeApplication Architecture
, as the architecture is more relevant for the developers, while users may want the continuous tutorial.What do you think?
My general impression is that README is in fact quite comprehensive documentation. So, absolutely agree with @pz-max that translating it into
read-the-docs
makes absolutely sense, as apart of the points we discussed, it facilitates navigation through the sections.