Skip to content

Grammar, copyedit and add me #111

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

Merged
ekatef merged 1 commit into from
Dec 2, 2025
Merged

Grammar, copyedit and add me #111

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
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This repository contains the documentation of PyPSA-Earth including:

## Installation

1. Make sure to have installed the PyPSA-Earth package and environment available at [this link](https://github.com/pypsa-meets-earth/pypsa-earth.git)
1. Ensure the [PyPSA-Earth package and environment](https://github.com/pypsa-meets-earth/pypsa-earth.git) is installed

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:

Expand All @@ -28,14 +28,14 @@ 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".
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"
- Guideline on "How to add new regions to PyPSA-Earth"
- Wrap-up - Hackathon-slides.pdf

### List of selected self-learning material
Expand All @@ -58,7 +58,7 @@ Useful packages to dive deeper into:
- [xarray](http://xarray.pydata.org/en/stable/tutorials-and-videos.html)
- [dask](https://github.com/dask/dask-tutorial)

### List of hero's with a successful Pull Request (GitHub exercise)
### List of heroes with a successful Pull Request (GitHub exercise)

- Lukas Franken from Germany
- Davide Fioriti from Italy
Expand Down Expand Up @@ -93,7 +93,8 @@ Useful packages to dive deeper into:
- Pierre Karamountzos from The Netherlands
- Albert Kreutzer from Germany
- Andrea Mastrantuono from Italy
- Khalid Jamour form Chad
- Khalid Jamour from Chad
- Femke Nijsse from the United Kingdom

## 2. Notebooks for data exploration

Expand Down
8 changes: 4 additions & 4 deletions hackathon/0_github_exercise_hands_on.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"\n",
"#### We will cover\n",
"\n",
"1. Overview to GitHub\n",
"1. Overview of GitHub\n",
"2. Basic pull-push workflow\n",
"3. Advanced workflow: 5 steps of code contribution\n",
"4. Hands-on test of workflow"
Expand All @@ -36,7 +36,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## 1. Overview to GitHub"
"## 1. Overview of GitHub"
]
},
{
Expand Down Expand Up @@ -254,7 +254,7 @@
" git push\n",
" ```\n",
" Are you receiving an error? For every first commit on a new branch it is required to set an upstream, so git\n",
" know where to push the changes. Git already recommend often after the error what to do. In my case:\n",
" know where to push the changes. Git often recommends what to do after the error. In my case:\n",
" ```\n",
" git push --set-upstream origin new_feature\n",
" ```\n",
Expand All @@ -270,7 +270,7 @@
" - Checking your fork online you can **compare** and start the **Pull Request (PR)** online with the interface\n",
" - Make sure choosing the right branch\n",
" \n",
" **Tip:** You should keep your branch as long active until the PR is merged. Usually when start developing a feature you create a **draft pull request** to show that you actively working on something. The PR updates with each new commit and shows how you progress and is the best point to ask for help. After the PR is ready for review you can convert it to a *full PR* that one maintainer will review. Once changes are reviewed and accepted (=merged) then you can delete the branch. "
" **Tip:** You should keep your branch as long active until the PR is merged. Usually, when starting to develop a feature, you create a **draft pull request** to show that you are actively working on something. The PR updates with each new commit and shows how you progress and is the best point to ask for help. After the PR is ready for review you can convert it to a *full PR* that one maintainer will review. Once changes are reviewed and accepted (=merged) then you can delete the branch. "
]
},
{
Expand Down