search

pypsa-meets-earth / pypsa-earth-lit

Streamlit module that works along a stable package version
https://viz.tauritron.com/
GNU Affero General Public License v3.0
2 stars 3 forks source link

updated readme and tools #16

Closed drifter089 closed 1 year ago

ekatef commented 1 year ago

Hello @drifter089! Great work :)

Attached a couple of general preliminary comments.

  1. 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;
  2. 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.

pz-max commented 1 year ago

Let's add the fixes of point 1. and merge before adding the proper documentation