Skip to content
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.

Sign up for GitHub

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

Jump to bottom

update docs once more #476

Merged
merged 1 commit into from
Oct 11, 2022
Merged

update docs once more #476

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 14 additions & 11 deletions doc/project_structure_and_credits.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
Project structure and credits
##########################################

PyPSA meets Earth is an open source initiative.
We implemented a project structure to enhance collaboration and give people responsibilities.
Therefore, the structure is not here to dictate, it is rather a structure that let people organise and think in different angles about the project.
The PyPSA-Earth model is maintained by the members of the PyPSA meets Earth initiative.
We implemented in the initiative a project structure to enhance collaboration and give people responsibilities.
Therefore, the structure is not here to dictate, it is rather a structure that let people organise and think from different angles about the project.

We all have the same goal. We want to create a long-term maintained, supported and steadily improving energy system model that is useful for industry and research. Every person helping towards achieving this goal is listed in the credits.

Expand All @@ -20,23 +20,26 @@ We all have the same goal. We want to create a long-term maintained, supported a
Project structure
====================


The structure might be adjusted in future:

- Director (`Max Parzen <https://www.linkedin.com/in/maximilian-parzen-b047a1126/>`_)
- `Co-Director <https://uoe-my.sharepoint.com/:b:/g/personal/s1827105_ed_ac_uk/EfjniQIxmfZIp8ih_WQuy-0BfCiOCLPKEvDZUuylp9xOhA?e=s7KRQy>`_ (`Davide Fioriti <https://www.linkedin.com/in/davide-fioriti-745693a5/>`_)
- `Data and Workflow leader <https://uoe-my.sharepoint.com/:b:/g/personal/s1827105_ed_ac_uk/EdHf1dHFvPhIuWRCPopR5KYB9viUJUkhm_WDhHMeFqbUtg?e=Ja0Mz0>`_ (temporary Davide and Max)
- Demand leader (`Pierre McWhannel <https://www.linkedin.com/in/pierre-mcwhannel/>`_)
- `AI leader <https://uoe-my.sharepoint.com/:b:/g/personal/s1827105_ed_ac_uk/EdHf1dHFvPhIuWRCPopR5KYB9viUJUkhm_WDhHMeFqbUtg?e=Ja0Mz0>`_ (`Lukas Franken <https://www.linkedin.com/in/lukas-franken-5a3045151/>`_)
- `PyPSA-Earth leader <https://uoe-my.sharepoint.com/:b:/g/personal/s1827105_ed_ac_uk/EdHf1dHFvPhIuWRCPopR5KYB9viUJUkhm_WDhHMeFqbUtg?e=Ja0Mz0>`_ (temporary Davide and Max)
- PyPSA-Earth-Sec leader (`Hazem Abdel-Khalek <https://www.linkedin.com/in/hazemakhalek/>`_ and `Leon Schumm <https://www.linkedin.com/in/leon-schumm-253b22201/>`_)
- `AI and demand leader <https://uoe-my.sharepoint.com/:b:/g/personal/s1827105_ed_ac_uk/EdHf1dHFvPhIuWRCPopR5KYB9viUJUkhm_WDhHMeFqbUtg?e=Ja0Mz0>`_ (`Lukas Franken <https://www.linkedin.com/in/lukas-franken-5a3045151/>`_)
- `Outreach leader <https://uoe-my.sharepoint.com/:b:/g/personal/s1827105_ed_ac_uk/EWeumVS1t2hMrAXPWzYj2VsBRYS12ArGwTR1Iuo7vJC78Q?e=xeIkW4>`_ (`Stuart James <https://www.linkedin.com/in/stuart-daniel-james/>`_)
- `Finance leader <https://uoe-my.sharepoint.com/:b:/g/personal/s1827105_ed_ac_uk/EbBuUGDNwrRBqmeT8xbQT3MBL1MOMkemCDXi7EMbzXEmHw?e=E3Cbc7>`_ (Not assigned)
- Western Asia Coordinator (`Kasım Zor <https://www.linkedin.com/in/kasimzor/>`_)

- `Finance leader <https://uoe-my.sharepoint.com/:b:/g/personal/s1827105_ed_ac_uk/EbBuUGDNwrRBqmeT8xbQT3MBL1MOMkemCDXi7EMbzXEmHw?e=E3Cbc7>`_ (Currently not assigned)
- Western Asia Coordinator (Emre Yorat and `Kasım Zor <https://www.linkedin.com/in/kasimzor/>`_)
- Central Asia (`Ekatarina Fedotova <https://www.linkedin.com/in/ekaterina-fedotova-ba8249234/>`)

.. _credits:

Credits
===============================
=============

The list below is outdated (December 2022). For maintenance reasons,
we refer the reader to the project website and GitHub repositories
listed on the `PyPSA meets Earth team page <https://pypsa-meets-earth.github.io/team.html>`_.

(sorted by continent, country, institution)

Expand Down
4 changes: 2 additions & 2 deletions doc/structure.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
The structure
##########################################

The main workflow structure built within PyPSA Africa is as follows:
The main workflow structure built within PyPSA-Earth is as follows:

1. Download and filter data: first raw input data shall be downloaded. PyPSA Africa provides automated
1. Download and filter data: first raw input data shall be downloaded. PyPSA-Earth provides automated
procedures to successfully download all the needed data from scratch, such as OpenStreetMap data,
specific potential of renewable sources, population, GDP, etc. Moreover, raw data shall be filtered to remove non-valid data and normalize the data
gathered from multiple sources.
Expand Down
8 changes: 4 additions & 4 deletions doc/tutorial.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ YouTube DevTutorials

If some of the above sounds quite unfamiliar, you might want to start with YouTube videos.
We recorded the following which help you with VScode, git, reading errors and fixing bugs:
- `How to set-up Visual Studio Code for Windows [PyPSA-Africa][DevTutorial]<https://www.youtube.com/watch?v=9cFOcDxDz7o&list=PLrn8FatUFb2qbNvAEPK9gU_SQ32ZhQBZG&index=1>`_
- `Find a bug, create a fix, contribute a pull request [PyPSA-Africa] [DevTutorial]<https://www.youtube.com/watch?v=HBubZEpIeXk&list=PLrn8FatUFb2qbNvAEPK9gU_SQ32ZhQBZG&index=2>`_
- `Land lock country bug - Understanding the bug [PyPSA-Africa][DevTutorial]<https://www.youtube.com/watch?v=zOQpV5bgPPk&list=PLrn8FatUFb2qbNvAEPK9gU_SQ32ZhQBZG&index=3>`_
- `Land lock country bug - Fixing the bug [PyPSA-Africa][DevTutorial]<https://www.youtube.com/watch?v=6keiD6HvnmY&list=PLrn8FatUFb2qbNvAEPK9gU_SQ32ZhQBZG&index=4>`_
- `How to set-up Visual Studio Code for Windows [PyPSA-Earth][DevTutorial]<https://www.youtube.com/watch?v=9cFOcDxDz7o&list=PLrn8FatUFb2qbNvAEPK9gU_SQ32ZhQBZG&index=1>`_
- `Find a bug, create a fix, contribute a pull request [PyPSA-Earth] [DevTutorial]<https://www.youtube.com/watch?v=HBubZEpIeXk&list=PLrn8FatUFb2qbNvAEPK9gU_SQ32ZhQBZG&index=2>`_
- `Land lock country bug - Understanding the bug [PyPSA-Earth][DevTutorial]<https://www.youtube.com/watch?v=zOQpV5bgPPk&list=PLrn8FatUFb2qbNvAEPK9gU_SQ32ZhQBZG&index=3>`_
- `Land lock country bug - Fixing the bug [PyPSA-Earth][DevTutorial]<https://www.youtube.com/watch?v=6keiD6HvnmY&list=PLrn8FatUFb2qbNvAEPK9gU_SQ32ZhQBZG&index=4>`_
2 changes: 1 addition & 1 deletion doc/wildcards.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Wildcards
#########

It is easy to run PyPSA-Africa for multiple scenarios using the wildcards feature of ``snakemake``.
It is easy to run PyPSA-Earth for multiple scenarios using the wildcards feature of ``snakemake``.
Wildcards allow to generalise a rule to produce all files that follow a regular expression pattern
which e.g. defines one particular scenario. One can think of a wildcard as a parameter that shows
up in the input/output file names of the ``Snakefile`` and thereby determines which rules to run,
Expand Down