Skip to content

Commit

Permalink
Merge pull request #193 from OpenEnergyPlatform/feature-188-source-au…
Browse files Browse the repository at this point in the history 
…thors

Add 'authors' to section 'sources' #188
  • Loading branch information
@Ludee
Ludee authored Oct 29, 2024
2 parents d8a9192 + b13b24c commit 1578fb0
Show file tree
Hide file tree
Showing 5 changed files with 40 additions and 21 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ Here is a template for new release sections
- Implement schema build system v1: Enhance the resolve and generation module [(#180)](https://github.com/OpenEnergyPlatform/oemetadata/pull/180)
- Add basic documentation with MKdocs [(#184)](https://github.com/OpenEnergyPlatform/oemetadata/pull/184)
- Add key 'publisher' to section 'context' [(#191)](https://github.com/OpenEnergyPlatform/oemetadata/pull/191)
- Add an array 'authors' in section 'sources'. [(#193)](https://github.com/OpenEnergyPlatform/oemetadata/pull/193)
- Add a key description to collection and update badges [(#195)](https://github.com/OpenEnergyPlatform/oemetadata/pull/195)

### Changed
Expand Down
16 changes: 16 additions & 0 deletions metadata/v20/build_source/schemas/sources.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,22 @@
"badge": "Bronze",
"title": "Source Title"
},
"authors": {
"description": "An array of the full names of the authors of the source material.",
"type": "array",
"items": {
"description": "The authors of the source.",
"example": ["Hoesung Lee","José Romero", "The Core Writing Team"],
"type": [
"string",
"null"
],
"badge": "Bronze",
"title": "Keyword"
},
"badge": "Bronze",
"title": "Keywords"
},
"description": {
"description": "A free text description of the source.",
"example": "A Report of the Intergovernmental Panel on Climate Change.",
Expand Down
4 changes: 2 additions & 2 deletions metadata/v20/build_source/schemas/spatial.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
"title": "Address"
},
"latitude": {
"description": "The latitude (lat) information of the location.",
"description": "The latitude (lat) information of the location. Specifies the north / south position of the geometry.",
"example": "52.432822",
"type": [
"string",
Expand All @@ -42,7 +42,7 @@
"title": "Latitude"
},
"longitude": {
"description": "The longitude (lon) information of the location.",
"description": "The longitude (lon) information of the location. Specifies the east / west position of the geometry.",
"example": "13.5351004",
"type": [
"string",
Expand Down
4 changes: 2 additions & 2 deletions metadata/v20/build_source/schemas/temporal.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
"string",
"null"
],
"badge": "Silver",
"badge": "Gold",
"title": "Timeseries Alignment"
},
"aggregationType": {
Expand All @@ -73,7 +73,7 @@
"string",
"null"
],
"badge": "Silver",
"badge": "Gold",
"title": "Timeseries Aggregation Type"
}
},
Expand Down
36 changes: 19 additions & 17 deletions metadata/v20/metadata_key_description.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,25 +117,27 @@ If a value is not yet available, use: 'ToDo'.
|-------|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|
| 1 | **sources** | An array of objects with the used and underlying sources of the data and metadata. | | |
| 1.1 | title | A human readable title of the source, a document title or organisation name. | IPCC Sixth Assessment Report (AR6) - Climate Change 2023 - Synthesis Report | Bronze |
| 1.2 | description | A free text description of the source. | A Report of the Intergovernmental Panel on Climate Change | Bronze |
| 1.3 | path | A URL to the original source. | https://www.ipcc.ch/report/ar6/syr/downloads/report/IPCC_AR6_SYR_FullVolume.pdf | Bronze |
| 1.4 | **licenses** | An array of objects of licenses under which the described source is provided. See https://openenergyplatform.github.io/academy/courses/08_licensing/ for further information. | | |
| 1.4.1 | name | The [SPDX](https://spdx.org/licenses/) identifier. | ODbL-1.0 | Bronze |
| 1.4.2 | title | The official (human-readable) title of the license. | Open Data Commons Open Database License 1.0 | Bronze |
| 1.4.3 | path | A link or path to the license text. | https://opendatacommons.org/licenses/odbl/1-0/index.html | Bronze |
| 1.4.4 | instruction | A short description of rights and obligations. The use of [tl;drLegal](https://tldrlegal.com/) is recommended. | You are free to share and change, but you must attribute, and share derivations under the same license. See https://tldrlegal.com/license/odc-open-database-license-odbl for further information. | Bronze |
| 1.4.5 | attribution | A copyright owner of the **source**. Must be provided if attribution licenses are used. | © Intergovernmental Panel on Climate Change 2023 | Bronze |
| 1.4.6 | copyrightStatement | A link or path that proves that the source or data has the appropriate license. This can be a page number or website imprint. | https://www.ipcc.ch/copyright/ | Bronze |
| 1.2 | authors | An array of the full names of the authors of the source material. | Hoesung Lee,José Romero, The Core Writing Team | Bronze |
| 1.3 | description | A free text description of the source. | A Report of the Intergovernmental Panel on Climate Change | Bronze |
| 1.4 | path | A URL to the original source. | https://www.ipcc.ch/report/ar6/syr/downloads/report/IPCC_AR6_SYR_FullVolume.pdf | Bronze |
| 1.5 | **licenses** | An array of objects of licenses under which the described source is provided. See https://openenergyplatform.github.io/academy/courses/08_licensing/ for further information. | | |
| 1.5.1 | name | The [SPDX](https://spdx.org/licenses/) identifier. | ODbL-1.0 | Bronze |
| 1.5.2 | title | The official (human-readable) title of the license. | Open Data Commons Open Database License 1.0 | Bronze |
| 1.5.3 | path | A link or path to the license text. | https://opendatacommons.org/licenses/odbl/1-0/index.html | Bronze |
| 1.5.4 | instruction | A short description of rights and obligations. The use of [tl;drLegal](https://tldrlegal.com/) is recommended. | You are free to share and change, but you must attribute, and share derivations under the same license. See https://tldrlegal.com/license/odc-open-database-license-odbl for further information. | Bronze |
| 1.5.5 | attribution | A copyright owner of the **source**. Must be provided if attribution licenses are used. | © Intergovernmental Panel on Climate Change 2023 | Bronze |
| 1.5.6 | copyrightStatement | A link or path that proves that the source or data has the appropriate license. This can be a page number or website imprint. | https://www.ipcc.ch/copyright/ | Bronze |

### Resource - Licenses Keys
| # | Key | Description | Example | Badge |
|-----|--------------|----------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|
| 1 | **licenses** | An array of objects of licenses under which the described data is provided. | | |
| 1.1 | name | The [SPDX](https://spdx.org/licenses/) identifier. | ODbL-1.0 | Bronze |
| 1.2 | title | The official (human-readable) title of the license. | Open Data Commons Open Database License 1.0 | Bronze |
| 1.3 | path | A link or path to the license text. | https://opendatacommons.org/licenses/odbl/1-0/index.html | Bronze |
| 1.4 | instruction | A short description of rights and obligations. The use of [tl;drLegal](https://tldrlegal.com/) is recommended. | You are free to share and change, but you must attribute, and share derivations under the same license. See https://tldrlegal.com/license/odc-open-database-license-odbl for further information. | Bronze |
| 1.5 | attribution | A copyright owner of the **data**. Must be provided if attribution licenses are used. | © Reiner Lemoine Institut | Bronze |
| # | Key | Description | Example | Badge |
|-----|--------------------|---------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|
| 1 | **licenses** | An array of objects of licenses under which the described data is provided. | | |
| 1.1 | name | The [SPDX](https://spdx.org/licenses/) identifier. | ODbL-1.0 | Bronze |
| 1.2 | title | The official (human-readable) title of the license. | Open Data Commons Open Database License 1.0 | Bronze |
| 1.3 | path | A link or path to the license text. | https://opendatacommons.org/licenses/odbl/1-0/index.html | Bronze |
| 1.4 | instruction | A short description of rights and obligations. The use of [tl;drLegal](https://tldrlegal.com/) is recommended. | You are free to share and change, but you must attribute, and share derivations under the same license. See https://tldrlegal.com/license/odc-open-database-license-odbl for further information. | Bronze |
| 1.5 | attribution | A copyright owner of the **data**. Must be provided if attribution licenses are used. | © Reiner Lemoine Institut | Bronze |
| 1.6 | copyrightStatement | A link or path that proves that the data has the appropriate license. This can be a page number or website imprint. | https://www.ipcc.ch/copyright/ | Bronze |

### Resource - Provenance Keys
| # | Key | Description | Example | Badge |
Expand Down

0 comments on commit 1578fb0

Please sign in to comment.