Skip to content

Commit

Permalink
Merge pull request #240 from ebroda/feature-typos
Browse files Browse the repository at this point in the history
Fix some typos and naming of GitHub
  • Loading branch information
jh-RLI authored Aug 21, 2024
2 parents 2358891 + f4f6a19 commit 2641767
Show file tree
Hide file tree
Showing 19 changed files with 415 additions and 427 deletions.
22 changes: 11 additions & 11 deletions docs/courses/02_start.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# 02 - How to get started with the Open Energy Family and Platform

You will learn how to register as a user with the Open Energy Platform (OEP) and why and how to register also with github.
You will learn how to register as a user with the Open Energy Platform (OEP) and why and how to register also with GitHub.

You can provide feedback to this course on github: [https://github.com/OpenEnergyPlatform/academy/issues/164](https://github.com/OpenEnergyPlatform/academy/issues/164)
You can provide feedback to this course on GitHub: [https://github.com/OpenEnergyPlatform/academy/issues/164](https://github.com/OpenEnergyPlatform/academy/issues/164)

## For whom is this training and what can you learn?

Expand All @@ -12,8 +12,8 @@ You can provide feedback to this course on github: [https://github.com/OpenEnerg

:oep-icon-info: **After reading the sections of this training course you will**
- be able to interact as a user with the OEP
- understand why a github account is needed to contribute to development
- be able to register with github
- understand why a GitHub account is needed to contribute to development
- be able to register with GitHub

## How do I get started with the OEP?

Expand All @@ -31,19 +31,19 @@ This includes your profile information and any data tables you have already cont

The API token is necessary to make authenticated requests to the API (API = Application Programming Interface). You will use the API in case you want to connect to the OEP using programming skills.

## Why and how to register with github?
## Why and how to register with GitHub?

:oep-icon-info: **Why register with github?**
:oep-icon-info: **Why register with GitHub?**

When you interact with the OEP you also interact with the Open Energy Family (OEF). The development of the OEF and OEP is a community effort that takes place openly at github in the github group [Open Energy Platform](https://github.com/OpenEnergyPlatform). There, the various family members of the OEF are developed in different [repositories](https://github.com/orgs/OpenEnergyPlatform/repositories). We welcome you to participate in their development. To be able to do so, you will thus need to register with github. You can do so at no cost.
When you interact with the OEP you also interact with the Open Energy Family (OEF). The development of the OEF and OEP is a community effort that takes place openly at GitHub in the GitHub group [Open Energy Platform](https://github.com/OpenEnergyPlatform). There, the various family members of the OEF are developed in different [repositories](https://github.com/orgs/OpenEnergyPlatform/repositories). We welcome you to participate in their development. To be able to do so, you will thus need to register with GitHub. You can do so at no cost.

:oep-icon-info: **How to register with github and become part of the Open Energy Family team?**
:oep-icon-info: **How to register with GitHub and become part of the Open Energy Family team?**

If you do not yet have a github account, you need to [register with github](https://github.com/join). You will then need to become a member of the group [OpenEnergyPlatform](https://github.com/OpenEnergyPlatform) by getting invited to the group. This works as follows: Get in touch via the [OpenEnergy Platform contact form](https://openenergyplatform.org/contact). Fill in the form with your request to be added to the OpenEnergyPlatform group on github. An example text is provided in the screenshot below.
If you do not yet have a GitHub account, you need to [register with GitHub](https://github.com/join). You will then need to become a member of the group [OpenEnergyPlatform](https://github.com/OpenEnergyPlatform) by getting invited to the group. This works as follows: Get in touch via the [OpenEnergy Platform contact form](https://openenergyplatform.org/contact). Fill in the form with your request to be added to the OpenEnergyPlatform group on GitHub. An example text is provided in the screenshot below.

![image](../data/img/02_contact.JPG)

The response is not automated and thus not immediate. Please wait until you receive an invitation to the github group.
The response is not automated and thus not immediate. Please wait until you receive an invitation to the GitHub group.

We collected a few links to GitHub and git basics [here](https://openenergyplatform.github.io/academy/courses/05_ontology/#3-github-and-git-basics) for your first steps.

Expand All @@ -59,4 +59,4 @@ We collected a few links to GitHub and git basics [here](https://openenergyplatf
- License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/deed.en)
- Attribution: Öko-Institut (2023): How to get started with the Open Energy Family and Platform.
- Last update: :oep-auto-lastupdate:
- You can provide feedback to this course on github: [https://github.com/OpenEnergyPlatform/academy/issues/164](https://github.com/OpenEnergyPlatform/academy/issues/164)
- You can provide feedback to this course on GitHub: [https://github.com/OpenEnergyPlatform/academy/issues/164](https://github.com/OpenEnergyPlatform/academy/issues/164)
6 changes: 3 additions & 3 deletions docs/courses/03_download.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Learn to find and download [data](https://openenergyplatform.org/dataedit/schemas) on the OEP.

You can provide feedback to this course on github: [https://github.com/OpenEnergyPlatform/academy/issues/165](https://github.com/OpenEnergyPlatform/academy/issues/165)
You can provide feedback to this course on GitHub: [https://github.com/OpenEnergyPlatform/academy/issues/165](https://github.com/OpenEnergyPlatform/academy/issues/165)

## For whom is this training and what can you learn?

Expand All @@ -28,7 +28,7 @@ This tutorial teaches you how to use the free text search and tags to filter for
## How can I download / interact with data on the OEP?

:oep-icon-text: [How to download data - CSV and data package](../tutorials/99_other/download.md) (tutorial):
Learn how easy it is do download any data table you are viewing on the OEP table with only one click and why a data package makes a difference.
Learn how easy it is to download any data table you are viewing on the OEP table with only one click and why a data package makes a difference.

:oep-icon-code: [Data queries via API](../tutorials/01_api/01_api_download.ipynb) (tutorial):
This tutorial provides an overview of how you can select, filter and download data that resides on the OEP via the REST-full-HTTP
Expand Down Expand Up @@ -58,4 +58,4 @@ If you prefer command line over python, we have you covered: please check this t
- License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/deed.en)
- Attribution: Öko-Institut (2022): Download - Find and download / interact with data.
- Last update: :oep-auto-lastupdate:
- You can provide feedback to this course on github: [https://github.com/OpenEnergyPlatform/academy/issues/165](https://github.com/OpenEnergyPlatform/academy/issues/165)
- You can provide feedback to this course on GitHub: [https://github.com/OpenEnergyPlatform/academy/issues/165](https://github.com/OpenEnergyPlatform/academy/issues/165)
10 changes: 5 additions & 5 deletions docs/courses/04_upload.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ tags:
# 04 - Upload - Contribute data to the OEP

Learn how to publish data on the OEP.
You can provide feedback to this course on github: [https://github.com/OpenEnergyPlatform/academy/issues/166](https://github.com/OpenEnergyPlatform/academy/issues/166)
You can provide feedback to this course on GitHub: [https://github.com/OpenEnergyPlatform/academy/issues/166](https://github.com/OpenEnergyPlatform/academy/issues/166)

## For whom is this training and what can you learn?

Expand All @@ -31,17 +31,17 @@ This tutorial teaches you step-by-step on how to upload data from a .csv file to

:oep-icon-text: , </i>:oep-icon-code: [Beginners Guide: How to upload data to the OpenEnergy Platform and initiate the review process](../tutorials/99_other/beginners_guide.md) (tutorial):

This tutorial (also available as PDF) describes how to upload data to the OEP using Python and the REST-API. Several steps are needed to contribute actively to the platform. Some of these you only need to do once to get started. The steps described in this document are the following: Register at the OpenEnergy Platform, Register at github and get invited to the OpenEnergy Platform Group, Create data table(s) and upload data table(s), create metadata and upload metadata to github, initiate data review, create scenario factsheets.
This tutorial (also available as PDF) describes how to upload data to the OEP using Python and the REST-API. Several steps are needed to contribute actively to the platform. Some of these you only need to do once to get started. The steps described in this document are the following: Register at the OpenEnergy Platform, Register at GitHub and get invited to the OpenEnergy Platform Group, Create data table(s) and upload data table(s), create metadata and upload metadata to GitHub, initiate data review, create scenario factsheets.

## How can I publish data to the OEP with programming skills?

:oep-icon-code: [How to upload data (and metadata) using the API](../tutorials/01_api/02_api_upload.ipynb) (tutorial:

This jupyter notebook tutorial provides you a quick way of having all the code at hand to upload your data and metadata to the OEP.

:oep-icon-code: [Use the OEP Client to upload data to the OEP](https://github.com/OpenEnergyPlatform/oep-client/) (github link):
:oep-icon-code: [Use the OEP Client to upload data to the OEP](https://github.com/OpenEnergyPlatform/oep-client/) (GitHub link):

This is a link to github where the OEP Client resides, including the documentation. You can use the OEP Client to upload data to the OEP. Below are two more specific tutorials providing you with hands-on information to use the OEP Client.
This is a link to GitHub where the OEP Client resides, including the documentation. You can use the OEP Client to upload data to the OEP. Below are two more specific tutorials providing you with hands-on information to use the OEP Client.

:oep-icon-code: [Upload data using the OEP Client in a python script](../tutorials/02_oep_client/02_client_python_upload.ipynb) (tutorial):

Expand All @@ -63,4 +63,4 @@ This jupyter notebook tutorial provides you a quick way of having all the code a
- License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/deed.en)
- Attribution: Öko-Institut (2022): Upload - Contribute data to the OEP.
- Last update: :oep-auto-lastupdate:
- You can provide feedback to this course on github: [https://github.com/OpenEnergyPlatform/academy/issues/166](https://github.com/OpenEnergyPlatform/academy/issues/166)
- You can provide feedback to this course on GitHub: [https://github.com/OpenEnergyPlatform/academy/issues/166](https://github.com/OpenEnergyPlatform/academy/issues/166)
6 changes: 3 additions & 3 deletions docs/courses/05_ontology.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 05 - The Open Energy Ontology (OEO)
Learn about how to become an OEO developer and which skills are helpful to join in on developing the OEO.
You can provide feedback to this course on github: [https://github.com/OpenEnergyPlatform/academy/issues/167](https://github.com/OpenEnergyPlatform/academy/issues/167)
You can provide feedback to this course on GitHub: [https://github.com/OpenEnergyPlatform/academy/issues/167](https://github.com/OpenEnergyPlatform/academy/issues/167)

## How to become an OEO developer

Expand Down Expand Up @@ -71,7 +71,7 @@ Energy is a complex physical phenomenon and challenging to describe ontologicall

### I have read everything - how can I join the developer team now?

1. Get in touch with us! You can use the [contact form on the OEP](https://openenergyplatform.org/contact/) to establish initial contact and we will back to you.
1. Get in touch with us! You can use the [contact form on the OEP](https://openenergyplatform.org/contact/) to establish initial contact, and we will come back to you.
2. We always welcome new members to the development team in our regular oeo-dev-meetings, where we discuss organisational things and content related issues.
3. To participate in the OEO development and discussion process on GitHub, you will need to become part of the [OpenEnergyFamily organisation](https://github.com/OpenEnergyPlatform).
4. Afterwards, you can follow all instructions and explanations of the general workflow in the [CONTRIBUTING.md](https://github.com/OpenEnergyPlatform/ontology/blob/dev/CONTRIBUTING.md) on GitHub.
Expand All @@ -89,6 +89,6 @@ Energy is a complex physical phenomenon and challenging to describe ontologicall
- License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/deed.en)
- Attribution: Fraunhofer IEE, Reiner Lemoine Institut, Otto-von-Guericke-Universität, Öko-Institut (2023): Contribute to the OEO.
- Last update: :oep-auto-lastupdate:
- You can provide feedback to this course on github: [https://github.com/OpenEnergyPlatform/academy/issues/167](https://github.com/OpenEnergyPlatform/academy/issues/167)
- You can provide feedback to this course on GitHub: [https://github.com/OpenEnergyPlatform/academy/issues/167](https://github.com/OpenEnergyPlatform/academy/issues/167)

---
6 changes: 3 additions & 3 deletions docs/courses/06_enable_comparisons.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
This training course provides guidance on how you can document typical numerical data from climate and energy modelling so
that the likelihood of a good-quality semi-automated scenario projection comparison based on the Open Enrgy Knowledgegraph (OEKG) increases.

You can provide feedback to this course on github: [https://github.com/OpenEnergyPlatform/academy/issues/174](https://github.com/OpenEnergyPlatform/academy/issues/174)
You can provide feedback to this course on GitHub: [https://github.com/OpenEnergyPlatform/academy/issues/174](https://github.com/OpenEnergyPlatform/academy/issues/174)

## For whom is this training and what can you learn?

Expand All @@ -22,7 +22,7 @@ The OEP allows you to contribute numerical data in any structure and in any unit

This potential heterogenity of how numerical data is structured and documented in terms of units, makes it challenging for semi-automated scenario projection comparisons to provide spot on results.

Thus we decided to provide some guidance on how to document your data so that the likelihood increases this data contributes to good quality semi-automated scenario projection comparisons that - sometime in the future - the OEKG will offer on the OEP.
Thus, we decided to provide some guidance on how to document your data so that the likelihood increases this data contributes to good quality semi-automated scenario projection comparisons that - sometime in the future - the OEKG will offer on the OEP.

Below we compiled a limited list of key input- and output data to many energy systems models. For those we suggest to report data in specific units.

Expand Down Expand Up @@ -78,4 +78,4 @@ If a variable / parameter is already represented in the [Open Energy Ontology](h
- Contact: [email protected]. License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/deed.en)
- Attribution: Öko-Institut (2023): Comparing data - Enable scenario projection comparison on the Open Energy Platform.
- Last update: :oep-auto-lastupdate:
- You can provide feedback to this course on github: [https://github.com/OpenEnergyPlatform/academy/issues/174](https://github.com/OpenEnergyPlatform/academy/issues/174)
- You can provide feedback to this course on GitHub: [https://github.com/OpenEnergyPlatform/academy/issues/174](https://github.com/OpenEnergyPlatform/academy/issues/174)
4 changes: 2 additions & 2 deletions docs/courses/08_licensing.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 08 - Licensing

You can provide feedback to this course on github: [https://github.com/OpenEnergyPlatform/academy/issues/188](https://github.com/OpenEnergyPlatform/academy/issues/188)
You can provide feedback to this course on GitHub: [https://github.com/OpenEnergyPlatform/academy/issues/188](https://github.com/OpenEnergyPlatform/academy/issues/188)

## For whom is this training and what can you learn?

Expand Down Expand Up @@ -268,4 +268,4 @@ resources will be created.
- Contact:
- License: [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/deed.en)
- Attribution: Open Energy Academy - Licensing Course © [Reiner Lemoine Institut](https://reiner-lemoine-institut.de/)
- You can provide feedback to this course on github: [https://github.com/OpenEnergyPlatform/academy/issues/188](https://github.com/OpenEnergyPlatform/academy/issues/188)
- You can provide feedback to this course on GitHub: [https://github.com/OpenEnergyPlatform/academy/issues/188](https://github.com/OpenEnergyPlatform/academy/issues/188)
4 changes: 2 additions & 2 deletions docs/courses/09_peer_review.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ tags:

This course will introduce you to Open Peer Review on the OEP. At the moment it provides basic insights into Open Peer Review.

You can provide feedback to this course on github: [https://github.com/OpenEnergyPlatform/academy/issues/189](https://github.com/OpenEnergyPlatform/academy/issues/189)
You can provide feedback to this course on GitHub: [https://github.com/OpenEnergyPlatform/academy/issues/189](https://github.com/OpenEnergyPlatform/academy/issues/189)

!!! note

Expand Down Expand Up @@ -163,4 +163,4 @@ The editor is not implemented yet.
- Contact: [email protected]
- License: Creative Commons Attribution 4.0 International ([CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/deed.en))
- Attribution: Open Energy Academy - Licensing Course © [Reiner Lemoine Institut](https://reiner-lemoine-institut.de/) | [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/deed.en)
- You can provide feedback to this course on github: [https://github.com/OpenEnergyPlatform/academy/issues/189](https://github.com/OpenEnergyPlatform/academy/issues/189)
- You can provide feedback to this course on GitHub: [https://github.com/OpenEnergyPlatform/academy/issues/189](https://github.com/OpenEnergyPlatform/academy/issues/189)
4 changes: 2 additions & 2 deletions docs/courses/10_scenario_bundle.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ In a nutshell: A scenario bundle provides you with all relevant information to u
## How to create a scenario bundle
* Navigate to: https://openenergyplatform.org/scenario-bundles/main
* Click the **+Create** button
* Now you will presented with various areas that you can populate with information about your scenario.
* Now you will be presented with various areas that you can populate with information about your scenario.

**Note: if you are presented with a drop-down menu in the following forms, you will see already existing entries that may fit what you want to add. Then simply choose this information. If the information (e.g. an author) is not yet available from a drop-down menu, simply start typing what you would want to enter and your information will be added to the open energy knowledge graph that works in the background. Some drop-down menus (e.g. scenario years) have fixed entries and you won't be able to add your own information**
**Note: if you are presented with a drop-down menu in the following forms, you will see already existing entries that may fit what you want to add. Then simply choose this information. If the information (e.g. an author) is not yet available from a drop-down menu, simply start typing what you would want to enter and your information will be added to the open energy knowledge graph that works in the background. Some drop-down menus (e.g. scenario years) have fixed entries, and you won't be able to add your own information**



Expand Down
Loading

0 comments on commit 2641767

Please sign in to comment.