Skip to content

Commit

Permalink
Update all OEP links #106
Browse files Browse the repository at this point in the history
  • Loading branch information
@Ludee
Ludee committed Nov 18, 2024
1 parent 8749b21 commit 2fadd0d
Show file tree
Hide file tree
Showing 37 changed files with 164 additions and 160 deletions.
8 changes: 6 additions & 2 deletions README.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Open Energy Metadata (OEMetadata)
* - Documentation
- |badge_documentation|
* - Publication
- |badge_pypi| |badge_pypi_downloads|
- |badge_pypi| |badge_python| |badge_pypi_downloads|
* - Development
- |badge_issue_open| |badge_issue_closes| |badge_pr_open| |badge_pr_closes|
* - Community
Expand Down Expand Up @@ -83,7 +83,11 @@ License and Citation

.. |badge_pypi| image:: https://img.shields.io/pypi/v/oemetadata
:target: https://pypi.org/project/oemetadata/
:alt: PyPI
:alt: PyPI Version

.. |badge_python| image:: https://img.shields.io/pypi/pyversions/oemetadata
:target: https://pypi.org/project/oemetadata/
:alt: PyPI Python Version

.. |badge_pypi_downloads| image:: https://img.shields.io/pypi/dm/oemetadata
:target: https://openenergyplatform.github.io/oemetadata/
Expand Down
6 changes: 3 additions & 3 deletions docs/metadata/metadata_key_description.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ If a value is not yet available, use: `ToDo`.
| 6 | languages | An array of languages used within the described data structures (e.g. titles, descriptions). The language key can be repeated if more languages are used. Standard: IETF (BCP47) | en-GB, de-DE, fr-FR | Gold |
| 7 | **subject** | An array of objects that references to the subjects of the resource in ontology terms. | |
| 7.1 | name | A class label of the ontology term. | energy | Platinum |
| 7.2 | path | A unique identifier (URI/IRI) of the ontology class. | https://openenergy-platform.org/ontology/oeo/OEO_00000150 | Platinum |
| 7.2 | path | A unique identifier (URI/IRI) of the ontology class. | https://openenergyplatform.org/ontology/oeo/OEO_00000150 | Platinum |
| 8 | keywords | An array of freely selectable keywords that help with searching and structuring. The keyword are used and managed in the OEP as table tags. | example, ODbL-1.0, NFDI4Energy | Silver |
| 9 | publicationDate | A date of publication of the data or metadata. The date format is ISO 8601 (YYYY-MM-DD). | 2024-10-15 | Bronze |
| 10 | **embargoPeriod** | An object that describes the embargo period during which public access to the data is not allowed. |
Expand Down Expand Up @@ -173,11 +173,11 @@ If a value is not yet available, use: `ToDo`.
| 1.1.5 | unit | The unit of a field. If it does not apply, use 'null'. If the unit is given in a separate field, reference this field (e.g. 'unit'). Use a space between numbers and units (100 m). | MW | Silver |
| 1.1.6 | **isAbout** | An array of objects that describes the field in ontology terms. |
| 1.1.6.1 | name | The class label of the ontology term. | wind energy converting unit | Platinum |
| 1.1.6.2 | path | The path of the ontology term (IRI). | https://openenergy-platform.org/ontology/oeo/OEO_00000044 | Platinum |
| 1.1.6.2 | path | The path of the ontology term (IRI). | https://openenergyplatform.org/ontology/oeo/OEO_00000044 | Platinum |
| 1.1.7 | **valueReference** | An array of objects for an extended description of the values in the column in ontology terms. | | |
| 1.1.7.1 | value | The name of the value in the column. | onshore | Platinum |
| 1.1.7.2 | name | The class label of the ontology term in the column. | onshore wind farm | Platinum |
| 1.1.7.3 | path | The path of the ontology term (IRI) in the column. | https://openenergy-platform.org/ontology/oeo/OEO_00000311 | Platinum |
| 1.1.7.3 | path | The path of the ontology term (IRI) in the column. | https://openenergyplatform.org/ontology/oeo/OEO_00000311 | Platinum |

#### Resource - Properties Keys
| # | Key | Description | Example | Badge |
Expand Down
2 changes: 1 addition & 1 deletion metadata/latest/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ SPDX-License-Identifier: CC0-1.0
<a href="https://github.com/OpenEnergyPlatform/oemetadata/"><img align="right" width="100" height="100" src="https://raw.githubusercontent.com/OpenEnergyPlatform/organisation/production/logo/OpenEnergyFamily_Logo_OEMetadata.png" alt="OpenEnergyMetadata"></a>
<a href="https://openenergyplatform.org/"><img align="right" width="100" height="100" src="https://avatars2.githubusercontent.com/u/37101913?s=400&u=9b593cfdb6048a05ea6e72d333169a65e7c922be&v=4" alt="OpenEnergyPlatform"></a>
<a href="https://github.com/OpenEnergyPlatform/oemetadata/"><img align="right" width="100" height="100" src="https://raw.githubusercontent.com/OpenEnergyPlatform/organisation/production/logo/OpenEnergyFamily_Logo_OEMetadata.png" alt="OpenEnergyMetadata"></a>
<a href="https://openenergy-platform.org/"><img align="right" width="100" height="100" src="https://avatars2.githubusercontent.com/u/37101913?s=400&u=9b593cfdb6048a05ea6e72d333169a65e7c922be&v=4" alt="OpenEnergyPlatform"></a>
<a href="https://openenergyplatform.org/"><img align="right" width="100" height="100" src="https://avatars2.githubusercontent.com/u/37101913?s=400&u=9b593cfdb6048a05ea6e72d333169a65e7c922be&v=4" alt="OpenEnergyPlatform"></a>


# OEMetadata - Version 2.0
Expand Down
2 changes: 1 addition & 1 deletion metadata/latest/build_source/schemas/general.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@
"@id": {
"description": "A unique identifier (URI/IRI) of the ontology class.",
"type": ["string", "null"],
"examples": ["https://openenergy-platform.org/ontology/oeo/OEO_00000150"],
"examples": ["https://openenergyplatform.org/ontology/oeo/OEO_00000150"],
"badge": "Platinum",
"title": "Subject Identifier",
"format": "uri"
Expand Down
2 changes: 1 addition & 1 deletion metadata/latest/example.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
"subject": [
{
"name": "energy",
"path": "https://openenergy-platform.org/ontology/oeo/OEO_00000150"
"path": "https://openenergyplatform.org/ontology/oeo/OEO_00000150"
}
],
"keywords": [
Expand Down
32 changes: 16 additions & 16 deletions metadata/latest/metadata_key_description.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ If a value is not yet available, use: `ToDo`.
| 6 | languages | An array of languages used within the described data structures (e.g. titles, descriptions). The language key can be repeated if more languages are used. Standard: IETF (BCP47) | en-GB, de-DE, fr-FR | Gold |
| 7 | **subject** | An array of objects that references to the subjects of the resource in ontology terms. | |
| 7.1 | name | A class label of the ontology term. | energy | Platinum |
| 7.2 | path | A unique identifier (URI/IRI) of the ontology class. | https://openenergy-platform.org/ontology/oeo/OEO_00000150 | Platinum |
| 7.2 | path | A unique identifier (URI/IRI) of the ontology class. | https://openenergyplatform.org/ontology/oeo/OEO_00000150 | Platinum |
| 8 | keywords | An array of freely selectable keywords that help with searching and structuring. The keyword are used and managed in the OEP as table tags. | example, ODbL-1.0, NFDI4Energy | Silver |
| 9 | publicationDate | A date of publication of the data or metadata. The date format is ISO 8601 (YYYY-MM-DD). | 2024-10-15 | Bronze |
| 10 | **embargoPeriod** | An object that describes the embargo period during which public access to the data is not allowed. |
Expand Down Expand Up @@ -169,22 +169,22 @@ If a value is not yet available, use: `ToDo`.
| 3 | encoding | Specifies the character encoding of the resource's data file. The default is 'UTF-8'. The values should be one of the 'Preferred MIME Names'. | UTF-8 | Gold |

#### Resource - Fields Keys
| # | Key | Description | Example | Badge |
|---------|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------|----------|
| 1 | **schema** | An object that describes the structure of a table. It contains all fields (columns of the table), the primary key and optional foreign keys. | | |
| 1.1 | **fields** | An array of objects that describes a field (column) and its detailed information. | | |
| 1.1.1 | name | The name of the field. The name may only consist of lowercase alphanumeric characters or underscores. It must not begin with a number or an underscore. | year | Iron |
| 1.1.2 | description | A text describing the field. | Reference year for which the data were collected. | Silver |
| 1.1.3 | type | The data type of the field. In case of a geom column in a database, also indicate the shape and CRS. | geometry(Point, 4326) | Iron |
| 1.1.4 | nullable | A boolean key to specify that a column can be nullable. True is the default value. | True | Iron |
| 1.1.5 | unit | The unit of a field. If it does not apply, use 'null'. If the unit is given in a separate field, reference this field (e.g. 'unit'). Use a space between numbers and units (100 m). | MW | Silver |
| # | Key | Description | Example | Badge |
|---------|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------|----------|
| 1 | **schema** | An object that describes the structure of a table. It contains all fields (columns of the table), the primary key and optional foreign keys. | | |
| 1.1 | **fields** | An array of objects that describes a field (column) and its detailed information. | | |
| 1.1.1 | name | The name of the field. The name may only consist of lowercase alphanumeric characters or underscores. It must not begin with a number or an underscore. | year | Iron |
| 1.1.2 | description | A text describing the field. | Reference year for which the data were collected. | Silver |
| 1.1.3 | type | The data type of the field. In case of a geom column in a database, also indicate the shape and CRS. | geometry(Point, 4326) | Iron |
| 1.1.4 | nullable | A boolean key to specify that a column can be nullable. True is the default value. | True | Iron |
| 1.1.5 | unit | The unit of a field. If it does not apply, use 'null'. If the unit is given in a separate field, reference this field (e.g. 'unit'). Use a space between numbers and units (100 m). | MW | Silver |
| 1.1.6 | **isAbout** | An array of objects that describes the field in ontology terms. |
| 1.1.6.1 | name | The class label of the ontology term. | wind energy converting unit | Platinum |
| 1.1.6.2 | path | The path of the ontology term (IRI). | https://openenergy-platform.org/ontology/oeo/OEO_00000044 | Platinum |
| 1.1.7 | **valueReference** | An array of objects for an extended description of the values in the column in ontology terms. | | |
| 1.1.7.1 | value | The name of the value in the column. | onshore | Platinum |
| 1.1.7.2 | name | The class label of the ontology term in the column. | onshore wind farm | Platinum |
| 1.1.7.3 | path | The path of the ontology term (IRI) in the column. | https://openenergy-platform.org/ontology/oeo/OEO_00000311 | Platinum |
| 1.1.6.1 | name | The class label of the ontology term. | wind energy converting unit | Platinum |
| 1.1.6.2 | path | The path of the ontology term (IRI). | https://openenergyplatform.org/ontology/oeo/OEO_00000044 | Platinum |
| 1.1.7 | **valueReference** | An array of objects for an extended description of the values in the column in ontology terms. | | |
| 1.1.7.1 | value | The name of the value in the column. | onshore | Platinum |
| 1.1.7.2 | name | The class label of the ontology term in the column. | onshore wind farm | Platinum |
| 1.1.7.3 | path | The path of the ontology term (IRI) in the column. | https://openenergyplatform.org/ontology/oeo/OEO_00000311 | Platinum |

#### Resource - Properties Keys
| # | Key | Description | Example | Badge |
Expand Down
Loading

0 comments on commit 2fadd0d

Please sign in to comment.