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.

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

Add general section to metadata tutorial #187 #198

Merged
merged 5 commits into from
Jun 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Here is a template for new release sections

### Added

- Add general section to metadata tutorial [(#198)](https://github.com/OpenEnergyPlatform/academy/pull/198)
- Add new open peer review course [(#196)](https://github.com/OpenEnergyPlatform/academy/pull/196)
- Add the file CONTRIBUTE.md [(#194)](https://github.com/OpenEnergyPlatform/academy/pull/194)
- Add new metadata course [(#195)](https://github.com/OpenEnergyPlatform/academy/pull/195)
Expand Down
12 changes: 8 additions & 4 deletions docs/courses/07_metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,24 +21,28 @@ tags:

## Introduction: What is Metadata?

ToDo
Metadata, in simple terms, refer to data about data.
They provide valuable information regarding the characteristics, properties,
and context of a specific data item.
Metadata answer the questions of "who, what, when, where, and how" related to the data.
Metadata plays a crucial role in organizing, managing, and understanding information.

## What is the Open Energy Metadata?

- The [Open Energy Metadata](https://github.com/OpenEnergyPlatform/oemetadata) (OEMetadata) describe a metadata standard used to annotate energy related data
- [Open Energy Metadata](https://github.com/OpenEnergyPlatform/oemetadata) (OEMetadata) describe a metadata standard used to annotate energy related data
- The development of OEMetadata is a community effort and takes place on [GitHub](https://github.com/OpenEnergyPlatform/oemetadata/issues)
- In the following sections of this course we have collected information on how to use the standard
- There is a short :oep-icon-code: [tutorial on how to get started with OEMetadata](../tutorials/metadata/getting_started_with_OEMetadata.ipynb)

## What's the meaning of all the metadata keys?

- There is a comprehensive list of keys, their meaning and example uses in the :oep-icon-text: [key description](https://github.com/OpenEnergyPlatform/oemetadata/blob/master/metadata/latest/metadata_key_description.md) in the OEMetadata repository
- The OEMetadata repository provides a comprehensive list of keys, along with their meanings and examples of their uses, in the [key description](https://github.com/OpenEnergyPlatform/oemetadata/blob/master/metadata/latest/metadata_key_description.md) section.

## How can I work with OEMetadata?

- A :oep-icon-code: [guide on publishing data on the OEP](../tutorials/upload/OEP_Research_Data_Publishing_Guidebook.ipynb) includes the creation of metadata
- For all datasets on the [Open Energy Platform (OEP)](https://openenergy-platform.org/), you can look at provided metadata by clicking on "Meta Information"
- If you are the owner of the dataset, you can click "edit" and you're directly working on the OEMetadata
- [A guide on publishing data on the OEP](../tutorials/upload/OEP_Research_Data_Publishing_Guidebook.ipynb) includes the creation of metadata

## What other tools to work with OEMetadata are there?

Expand Down