Skip to content

Emre-Yorat89/pypsa_documentation

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PyPSA Earth Documentation

Size

- Getting ready to change the world!

This repository contains the documentation of PyPSA-Earth including:

  • hackathon material in folder hackathon (mandatory for beginners): it contains a 6-step introduction starting from the basics to learn PyPSA-Earth
  • sample notebooks to investigate the PyPSA-Earth repository in the folder notebooks
  • storage of documentation images in the folder doc

Installation

  1. Make sure to have installed the PyPSA-Earth package and environment available at this link

  2. Open your terminal at the parent location where PyPSA-Earth has been installed. Type the following in your terminal to download the package from GitHub:

       .../pypsa/earth/parent/folder % git clone https://github.com/pypsa-meets-earth/documentation.git

1. Hackathon material

Expected experience level: Beginner
Duration hackathon: 3 hours
Duration extra DIY exercises: 5 hours

Content:

Slides and jupyter notebook examples are provided in the folder hackathon. While there is a lot of theory and text, we always recommend to code & check out stuff where possible. Small examples also help you to "do rather than only observe".

  • Full GitHub workflow exercise for a PyPSA-Earth contribution
  • The architecture of PyPSA-Earth on GitHub
  • Development tools, requirements and installation of PyPSA-Earth
  • 3 ways of Snakemake executions and introduction to debugging
  • Code-Dev story on efficient vs. poor code and the role of discord
  • Guideline on "How to add to need regions to PyPSA-Earth"
  • Wrap-up - Hackathon-slides.pdf

List of selected self-learning material

Aim: We provide a couple of links to efficient self-learning material

Useful packages to dive deeper into:

List of hero's with a successfull Pull Request (GitHub exercise):

  • Lukas Franken from Germany
  • Davide Fioriti from Italy
  • Matin Mahmood from United Kingdom
  • Max Parzen from Germany
  • Thomas Lesieur from France
  • Jan Ohlenbusch from Germany
  • Taco Niet from Canada
  • Pierre McWhannel from Canada
  • Mariana Rodríguez-Arce from Costa Rica
  • Hana Elattar from Egypt---
  • Yerbol Akhmetov from Kazakhstan

2. Notebooks for data exploration

The folder notebooks contains useful notebooks to explore the data of PyPSA-Earth. The notebooks are self-explainatory and the pypsa-earth environment is needed to successfully run the examples.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Jupyter Notebook 100.0%