pypsa-meets-earth / pypsa-earth

PyPSA-Earth: A flexible Python-based open optimisation model to study energy system futures around the world.
https://pypsa-earth.readthedocs.io/en/latest/
207 stars 167 forks source link

add readme and intro fix #1007

Closed pz-max closed 2 months ago

pz-max commented 2 months ago

Closes # (if applicable).

Add figures and references to power system examples. People need to have a quick lick to Davide's zenodo repo.

Checklist

pz-max commented 2 months ago

Docs changes: image

pz-max commented 2 months ago

Good point 👍🏽 I will use them just the links from the read e image

pz-max commented 2 months ago

@davide-f

Thanks @pz-max ! A little comment, what do you think?

Changes accepted. Added now additionally some of the "how the docs" bits in the Contribute Section. The "how the docs" page was previously fully omitted. Feel free to merge when its fine.

FYI, also changed in the readthedocs admin options that there should be an independent docs build per PR such that we can review more easily. I guess it will be build with the next PR.

pz-max commented 2 months ago

@davide-f, I think there is a misunderstanding. I think the Readme pictures should be in the documentation. Not everybody is reading the Readme, and some non-dev people will default to the documentation. The global modelling pictures as well as the description to more model pictures is very useful (Tom B or others never find those).

So, my suggestion with the openmod image links was intended and, in my opinion, that is not a big overhead. This PR has nothing to do with the general docs picture architecture suggestion in Discord. If you agree, can you revert your commit? Happy to discuss in the next dev meeting

davide-f commented 2 months ago

Agree @pz-max , apologies; I reset the previous change. As CI passes, it gets merged :)