Skip to content

Commit

Permalink
Update oemetadata.md
Browse files Browse the repository at this point in the history 
Fix typos and minor mistakes
  • Loading branch information
@vismayajochem
vismayajochem authored Sep 24, 2024
1 parent 4dfb68b commit ca0a160
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions docs/tutorials/99_other/oemetadata.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<img src="https://raw.githubusercontent.com/OpenEnergyPlatform/academy/develop/docs/data/img/OEP_logo_2_no_text.svg" alt="OpenEnergy Platform" height="75" width="75" />

## Learnings
This tutorial will wnable you to:
This tutorial will enable you to:

- know what OEMetaData are
- create and modify OEMetaData
Expand All @@ -27,23 +27,23 @@ There are essintially two ways of creating OEMetaData. Both can be done with and

**Manually creating OEMetaData using the OMI**
You can manually create a OEMetaData dataset as a JSON-file on your computer. This might be useful if you want to create multiple OEMetaData datasets for tables, where some fields will be filled out the same. Then it is much easier to copy and paste the entries. It is possible to manually create OEMetaData and later on modify them via the OEMetaDataBuilder.
Note: Should only be done while using the [OpenMetadataIntegration](https://github.com/OpenEnergyPlatform/omi) (OMI). This way might result in faulty OEMetaData because the guidelines from the OEMetaDataBuilder are not provided while creating the dataset(s).
Note: Should only be done while using the [OpenMetadataIntegration](https://github.com/OpenEnergyPlatform/omi) (OMI). This way of creating OEMetaData might result in faulty OEMetaData because the guidelines from the OEMetaDataBuilder are not provided while creating the dataset(s).

**Creating OEMetaData using the OEMetaDataBuilder**
On the OEP there is a tool to create your OEMetaData directly on the platfrom. It is called [OEMetaDataBuilder](https://openenergyplatform.org/dataedit/oemetabuilder/) and can be used when there already exist a table on the OEP for which you want tor create the OEMetaData or as standalone version when no table for which the OEMetaData dataset is for exist on the OEP.
On the OEP there is a tool to create your OEMetaData directly on the platfrom. It is called [OEMetaDataBuilder](https://openenergyplatform.org/dataedit/oemetabuilder/) and can be used when there already exist a table on the OEP for which you want tor create the OEMetaData or as standalone version when no table, for which the OEMetaData dataset is for, exist on the OEP.

## How to use the OEMetaDataBuilder

You can find the [OEMetaDataBuilder](https://openenergyplatform.org/dataedit/oemetabuilder/) on the OEP under [Database](https://openenergyplatform.org/dataedit/schemas) by clicking on `OEMetaBuilder` in the upper right corner.
![Database](images/Screenshots_OEMetaData/0_Database.png)
Then the OEMetaDataBuilder opens and you can see all the fields. Right next to the headline `Create new Metadata` there are two buttons; With the first one (the pen) you can edit and/or copy the code on which this page is based on in a popup window. With the second (the menu) you can choose which fields will be shown or hidden by clicking on them in the list in the popup window. Whenever there is a such a `menu` button next to a headline it enables you to choose which fields will be shown or hidden. Beneath all fields is a description of what values and information may be filled in the field above. For more detailed information please see the [key descriptions](https://github.com/OpenEnergyPlatform/oemetadata/blob/develop/metadata/v160/metadata_key_description.md).
In order for the OEMetaData dataset to exist on the OEP the ID field must be filled out. You can also give a name, title and description to your OEMetaData. If you create OEMetaData to an already existing table some fields will be filled automatically once you filled in the ID of the table. This makes it easier for you and minimizes the possibles errors.
Then the OEMetaDataBuilder opens and you can see all the fields. Right next to the headline `Create new Metadata` there are two buttons; With the first one (the pen) you can edit and/or copy the code on which this page is based on in a popup window. With the second (the menu) you can choose which fields will be shown or hidden by clicking on them in the list in the popup window. Whenever there is a such a `menu` button next to a headline it enables you to choose which fields will be shown or hidden in the section the hedline belongs to. Beneath all fields is a description of what values and information may be filled in the field above. For more detailed information please see the [key descriptions](https://github.com/OpenEnergyPlatform/oemetadata/blob/develop/metadata/v160/metadata_key_description.md).
In order for the OEMetaData dataset to exist on the OEP the ID field must be filled out. You can also give a name, title and description to your OEMetaData. If you create OEMetaData to an already existing table some fields will be filled automatically once you filled in the ID of the table. This makes it easier for you and minimizes the possible errors.
![Anfang](images/Screenshots_OEMetaData/1_Anfang.png)
Under `Subject` you can provide subjects which describe your data. In the `Name`-field please provide the human readable name of the subject, e.g. energy. In the `Path`-field please provide the corresponding URL to the OEO, e.g. https://openenergy-platform.org/ontology/oeo/OEO_00000150. You can add subjects by clicking on the `+` right next to the headline `Subject`. Note: Subjects help other users to find you data and know what it is about.
Under `Subject` you can provide subjects which describe your data. In the `Name`-field please provide the human readable name of the subject, e.g. energy. In the `Path`-field please provide the corresponding URL to the OEO, e.g. https://openenergy-platform.org/ontology/oeo/OEO_00000150. You can add subjects by clicking on the `+` right next to the headline `Subject`. Note: Subjects help other users to find your data and know what it is about.
![Subject](images/Screenshots_OEMetaData/2_Subject.png)
You can provide language tag(s) for all languages used in your data, inculding the table and the OEMetaData dataset. You can add multiple languages by the `+` right next to the headline `Language`. Note: Please use the required standard (IETF (BCP47)).
You can provide language tag(s) for all languages used in your data, inculding the table and the OEMetaData dataset. You can add multiple languages by clicking on the `+` right next to the headline `Language`. Note: Please use the required standard (IETF (BCP47)).
![Language](images/Screenshots_OEMetaData/3_Language.png)
Additionally to the Subjects you can also provide `Keywors`. These don't have to be defined in the OEO, but can help to describe the content of your data even more precisly.
Additionally to the Subjects you can also provide `Keywords`. These don't have to be defined in the OEO, but can help to describe the content of your data even more precisly.
![Language](images/Screenshots_OEMetaData/4_Keywords.png)
You can give context to your data, e.g. a research project. This makes your data more comprehendable and traceable for others.
![Context](images/Screenshots_OEMetaData/5_Context_1.png)
Expand All @@ -52,7 +52,7 @@ You can specify the spatial context of your data, e.g. the region in which a res
![Spatial](images/Screenshots_OEMetaData/7_Spatial.png)
You can also define the time of your data. Either a reference date or a time span.
![Temporal](images/Screenshots_OEMetaData/8_Temporal.png)
You can add a `Timeseries` by clicking on the `+` next it. There you can specify start, end and resolution of the series and information about how the data is implemented in the table. You can add multiple timeseries if neccessarry.
You can add a `Timeseries` by clicking on the `+` next to the headline. There you can specify start, end and resolution of the series and information about how the data is implemented in the table. You can add multiple timeseries if neccessarry.
![Timeseries-1](images/Screenshots_OEMetaData/9_Timeseries-1.png)
![Timeseries-2](images/Screenshots_OEMetaData/10_Timeseries-2.png)
You can provide information on your `Sources`, `Licenses`, `Contributers` and `Recourses`. You can add each of them by clicking on the `+` next to the headline.
Expand All @@ -65,9 +65,9 @@ You can also provide the license of each source by providing the SPDX identifire
You may provide information about the contributors of your data. You can add multiple contributors and add details about their contribution.
![Contributors-1](images/Screenshots_OEMetaData/15_Contributors-1.png)
![Contributors-2](images/Screenshots_OEMetaData/16_Contributors-2.png)
You can also annotate the data in your table. This helps to make the data in your table comparable to others because it makes a connection between coulumns and/or fields to classes in the OEO. In order to do so you must add resource(s) by clicking on the `+` next to the headline `Recourses`. For all resources you must add an unique name. Ich bin etwas verwirrt und weiß nicht, ob ich das folgende richtig beschreibe!
You can also annotate the data in your table. This helps to make the data in your table comparable to others because it makes a connection between columns and/or fields to classes in the OEO. In order to do so you must add resource(s) by clicking on the `+` next to the headline `Recourses`. For all resources you must add an unique name. Ich bin etwas verwirrt und weiß nicht, ob ich das folgende richtig beschreibe!
![Resources](images/Screenshots_OEMetaData/17_Resources.png)
You can specify the content of a field in your table by identifiying the field, giving its description and data type.
You can specify the content of a field in your table by identifying the field, giving its description and data type.
![Field](images/Screenshots_OEMetaData/18_Field-1.png)
The important step of making the connection between the entries in your table and the classes of the ontology happens now by providing the human readable term and the path to the OEO.
![isabout](images/Screenshots_OEMetaData/19_isabout.png)
Expand All @@ -78,9 +78,9 @@ You can also give a `Primary Key` which uniquely identifies each row of your tab
![PrimaryKey](images/Screenshots_OEMetaData/22_PrimaryKey.png)
You can also refer to an other table by giving a `Foreign Key`.
![ForeignKey](images/Screenshots_OEMetaData/23_ForeignKeys.png)
If you want to reference another table you can provide the foreign table in the `Reyource`-field and then specifying which column should be referencced in the `Field` below.
If you want to reference another table you can provide the foreign table in the `Resource`-field and then specifying which column should be referencced in the `Field` below.
![References](images/Screenshots_OEMetaData/24_References.png)
At the end you can provide an explantation of your data in terms defined by the OEO and a URI via the DBpedia Databus.
At the end you can provide an explanation of your data in terms defined by the OEO and a URI via the DBpedia Databus.
![Ende](images/Screenshots_OEMetaData/25_Ende.png)
You can submit your OEMetaData if there already exist a table for your dataset. You can always download the dataset as a JSON-file or cancel the process using the buttons at the very end of the page.

Expand Down

0 comments on commit ca0a160

Please sign in to comment.