From 9f7dde8dea16894879ebc0654912a56120431fe7 Mon Sep 17 00:00:00 2001 From: Documentation Date: Thu, 16 Jan 2025 21:31:33 +0000 Subject: [PATCH] Deployed 82ff7af to develop with MkDocs 1.6.1 and mike 2.1.3 --- develop/index.html | 8 ++++---- develop/search/search_index.json | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/develop/index.html b/develop/index.html index f69a369..3cd19da 100644 --- a/develop/index.html +++ b/develop/index.html @@ -1215,11 +1215,11 @@

Open Energy Metadata

-

Data Package +

Frictionless +Data Package
-FAIR

-

5* LOD

+FAIR +5* LOD

diff --git a/develop/search/search_index.json b/develop/search/search_index.json index b09efe8..733a7e7 100644 --- a/develop/search/search_index.json +++ b/develop/search/search_index.json @@ -1 +1 @@ -{"config":{"lang":["en"],"separator":"[\\s\\-,:!=\\[\\]()\"/]+|(?!\\b)(?=[A-Z][a-z])|\\.(?!\\d)|&[lg]t;","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Welcome to the Documentation of the Open Energy Metadata","text":""},{"location":"#open-energy-metadata","title":"Open Energy Metadata","text":"

Open Energy Metadata (OEMetadata) is an energy metadata standard including a metadata schema, templates, and examples. It is an extensive set of metadata based on the Frictionless Data Package specifications and the FAIR Principles.

The documentation is structured in three main sections: - Development Collaborative Development - Metadata Documentation Keys and Mappings - Code Documentation Install, Scripts, Tests

"},{"location":"code/","title":"Functions","text":"

mkdocstrings

This software uses mkdocstings to render docstrings from files.

The code documentation is implemented by writing docstrings. See the mkdocstrings documentation.

"},{"location":"code/install/","title":"Install","text":"
  • requirements.txt
  • requirements_dev.txt
  • environment.yml
  • setup.py
  • pyproject.toml
"},{"location":"code/install/#usage-examples","title":"Usage Examples","text":"

pip install oemetadata

from metadata.latest.example import OEMETADATA_LATEST_EXAMPLE\n\nprint(OEMETADATA_LATEST_EXAMPLE)\n
from metadata.latest.schema import OEMETADATA_LATEST_SCHEMA\n\nprint(OEMETADATA_LATEST_SCHEMA)\n
from metadata.latest.template import OEMETADATA_LATEST_TEMPLATE\n\nprint(OEMETADATA_LATEST_TEMPLATE)\n
"},{"location":"code/style/","title":"Code Style","text":"

Common python styles

  • Pep8
  • https://google.github.io/styleguide/pyguide.html

TBD

"},{"location":"code/tests/","title":"Tests","text":""},{"location":"code/tests/#test-load-file","title":"Test - Load File","text":"

test_FILE_should_load

Warning

\"Cannot open FILE!\"

Solutions: - Check if the file path or name is correct - Check if the test path or name is correct

"},{"location":"code/tests/#test-validate-schema","title":"Test - Validate Schema","text":""},{"location":"code/tests/#validate-oemetadata-schema-with-json-schema","title":"Validate OEMetadata Schema with JSON Schema","text":"

test_jsonschema_should_validate_oemetadata_schema

Warning

\"Cannot validate OEMetadata Schema with JSON Schema (VERSION)!\"

Solutions: - Check if correct JSON Schema has been used - Check if OEMetadata Schema is valid

"},{"location":"code/tests/#validate-file-with-oemetadata-schema","title":"Validate FILE with OEMetadata Schema","text":"

test_oemetadata_schema_should_validate_FILE

Warning

\"Cannot validate FILE with OEMetadata Schema (VERSION)!\"

Solutions: - Check if correct OEMetadata Schema has been used - Check if OEMetadata Schema is valid - Check if FILE is valid

"},{"location":"code/tests/#test-correct-path","title":"Test - Correct path","text":"

test_FILE_should_have_correct_path

Warning

\"Wrong path in FILE (VERSION)!\"

Solutions: - Check if path is correct - Check if test path is correct

"},{"location":"development/collaboration/","title":"Collaboration","text":"

This open-source software is a collaborative effort. The repository has several elements to provide necessary functions.

"},{"location":"development/collaboration/citation/","title":"Citation","text":"

See the Cite this repository function or CITATION.cff for citation of this repository.

"},{"location":"development/collaboration/code_of_conduct/","title":"Code of Conduct","text":"

This repository is following the Contributor Covenant Code of Conduct. Everyone is asked to be self-reflective and always maintain a good culture of discussion and active participation.

"},{"location":"development/collaboration/contributing/","title":"Contributing","text":"

This software is licensed under an open-source license and can be downloaded, executed and modified. To contribute to the collaborative development follow the workflow described in CONTRIBUTING.md.

"},{"location":"development/collaboration/license/","title":"License","text":"

This software is developed under an open-source license. The selected license can be read in the LICENSE.txt.

"},{"location":"development/collaboration/users/","title":"Users","text":"

Known user of this software can be added to USERS.cff for reference.

"},{"location":"development/documentation/","title":"Documentation","text":"
  • README.rst
  • CHANGELOG.md
  • docs/
  • MkDocs
  • mkdocstrings
"},{"location":"development/documentation/#mkdocs","title":"MkDocs","text":"

MkDocs is a fast and simple static site generator that is used for documentation. The source files are written in Markdown, and configured with a single YAML configuration file mkdocs.yml. Material theme enables additional features and an elegant design.

"},{"location":"development/documentation/#install","title":"Install","text":"

Install the required packages in a python environment. pip install mkdocs install MkDocs pip install mkdocs-material install the material theme

"},{"location":"development/documentation/#build","title":"Build","text":"

Generate the documentation. mkdocs serve start the local live version of the documentation mkdocs build create a folder site with the documentation

"},{"location":"development/documentation/#publish","title":"Publish","text":""},{"location":"development/documentation/#manually","title":"Manually","text":"

Publish documentation on GitHub Pages. mkdocs gh-deploy manually deploys the documentation files

"},{"location":"development/documentation/#github-action","title":"GitHub Action","text":"

Deploy the documentation with GitHub Actions. The file .github\\workflows\\gh-pages.yml creates an automated GitHub workflow. It is configured to be pushed to the branch gh-page and then deployed online. A commit on the production branch triggers the workflow.

"},{"location":"development/git/","title":"Git","text":"
  • .gitignore

Copied from (A collection of useful .gitignore templates)[https://github.com/github/gitignore]. For more information about how .gitignore files work, and how to use them, see (Ignoring Files chapter)[https://git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository#_ignoring] of the Pro Git book.

  • issue_template
  • pull_request_template
  • workflows (testing)
"},{"location":"development/git/gitignore/","title":"Gitignore","text":"

Copied from A collection of useful .gitignore templates. For more information about .gitignore files, see the Ignoring Files chapter of the Pro Git book.

"},{"location":"development/release/","title":"Release","text":"

The software release has four main goals:

  1. Merge the new features to the production branch
  2. Create a GitHub Release
  3. Update the documentation
  4. Publish a new version of the package at PyPI

The \ud83d\udcdd RELEASE_PROCEDURE.md contain detailed instructions to do a release.

"},{"location":"metadata/","title":"Metadata Documentation","text":"

Open Energy Metadata (OEMetadata) is a metadata standard for the energy domain. It is an extensive set of metadata based on the Data Package Standard 2.0 and DCAT-AP 3.0 specifications. It is made to facilitate findability, accessibility, interoperability, and reusability (FAIR) of data. A badge system prioritises the keys and serves as a measure of the completeness and quality of the metadata entries.

The metadata schema is defined in JSON schema version 2020-12. The metadata contains keys in a nested JSON structure. The metadata standard includes the following files:

  • schema.json contains the complete metadata schema.
  • metadata_key_description.md contains a full description of each metadata key.
  • template.json contains an empty metadata string with all fields.
  • example.json contains a basic metadata example.
"},{"location":"metadata/metadata_key_description/","title":"Key Description","text":""},{"location":"metadata/metadata_key_description/#oemetadata-key-description","title":"OEMetadata - Key Description","text":"

This pages describes the key of OEMetadata version 2.0 . You can have a look at an empty template and a filled out example of the metadata string. The schema.json contains the complete metadata schema.

"},{"location":"metadata/metadata_key_description/#json-format","title":"JSON Format","text":"

The JSON format offers different formats:

  • key-value pair: JSON {\"key\":\"value\"}
  • array: JSON {\"key\": [\"value\",\"value\"]}
  • object {nested key}: JSON {\"key\": { \"key_a\":\"value\", \"key_b\":\"value\"}}
  • array of objects {nested array}: JSON {\"key\": [ {\"key_a\":\"value\"}, {\"key_a\":\"value\"}]}
"},{"location":"metadata/metadata_key_description/#metadata-keys","title":"Metadata Keys","text":""},{"location":"metadata/metadata_key_description/#cardinality","title":"Cardinality","text":"

The cardinality defines the number of times an element can occur.

  • [1] Mandatory
  • [0..1] Optional
  • [*] Multiple optional
  • [1..*] Mandatory and multiple optional
"},{"location":"metadata/metadata_key_description/#badges","title":"Badges","text":"

Badges indicate the priority of metadata keys. They are implemented as part of the Open Peer Review Process.

"},{"location":"metadata/metadata_key_description/#additional-information","title":"Additional information:","text":"

If a field is not applicable use: null. If a value is not yet available, use: ToDo.

"},{"location":"metadata/metadata_key_description/#collection-keys","title":"Collection Keys","text":"# Key Description Example Badge Card. 1 @context Explanation of metadata keys in ontology terms. context.json Platinum [0..1] 2 name A filename or database conform dataset name. oep_oemetadata Iron [1] 3 title A human readable dataset name. OEP OEMetadata Bronze [0..1] 4 description A free text description of the dataset. A collection of tables for the OEMetadata examples. Bronze [0..1] 5 id A unique identifier (UUID/DOI) for the dataset. databus.openenergyplatform.org/oeplatform Silver [0..1] 6 resources An array of objects of the resources. The dataset can contain several (database) tables. [*]"},{"location":"metadata/metadata_key_description/#resource-general-keys","title":"Resource - General Keys","text":"# Key Description Example Badge Card. 1 @id A Uniform Resource Identifier (URI) that links the resource via the OpenEnergyDatabus (DBpedia Databus). wri_global_power_plant_database Platinum [0..1] 2 name A filename or database conform table name. oemetadata_table_template Iron [1] 3 topics An array of predefined topics that correspond to the database schemas of the OEP. model_draft Bronze [*] 4 title A human readable table name. OEMetadata Table Template Silver [0..1] 5 path A unique identifier (URI/UUID/DOI) for the table or file. model_draft/oemetadata_table_template Bronze [0..1] 6 description A description of the table. It should be usable as summary information for the table that is described by the metadata. Example table used to illustrate the OEMetadata structure and features. Silver [0..1] 7 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 Gold [*] 8 subject An array of objects that references to the subjects of the resource in ontology terms. [*] 8.1 name A class label of the ontology term. energy Platinum [0..1] 8.2 @id A unique identifier (URI/IRI) of the ontology class. openenergyplatform.org/ontology/oeo/OEO_00000150 Platinum [0..1] 9 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 [*] 10 publicationDate A date of publication of the data or metadata. The date format is ISO 8601 (YYYY-MM-DD). 2024-10-15 Bronze [0..1] 11 embargoPeriod An object that describes the embargo period during which public access to the data is not allowed. [0..1] 11.1 start The start date of the embargo period. The date of the data (metadata) upload. 2024-10-11 Bronze [0..1] 11.2 end The end date of the embargo period. This is the envisioned publication date. 2025-01-01 Bronze [0..1] 11.3 isActive A boolean key that indicates if the embargo period is currently active. Must be changed to False on the embargo period end date. True Bronze [0..1]"},{"location":"metadata/metadata_key_description/#resource-context-keys","title":"Resource - Context Keys","text":"# Key Description Example Badge Card. 1 context An object that describes the general setting, environment, or project leading to the creation or maintenance of this dataset. In science this is can be the research project. [0..1] 1.1 title A title of the associated project. NFDI4Energy Gold [0..1] 1.2 homepage A URL of the project. nfdi4energy.uol.de Gold [0..1] 1.3 documentation A URL of the project documentation. nfdi4energy.uol.de/sites/about_us Gold [0..1] 1.4 sourceCode A URL of the source code of the project. github.com/NFDI4Energy Gold [0..1] 1.5 publisher The publishing agency of the data. This can be the OEP. Open Energy Platform (OEP) Gold [0..1] 1.6 publisherLogo A URL to the logo of the publishing agency of data. OpenEnergyFamily_Logo_OpenEnergyPlatform.svg Gold [0..1] 1.7 contact A reference to the creator or maintainer of the data set. It can be an email address or a GitHub handle. info@nfdi4energy.org Gold [0..1] 1.8 fundingAgency A name of the entity providing the funding. This can be a government agency or a company. Deutsche Forschungsgemeinschaft (DFG) Gold [0..1] 1.9 fundingAgencyLogo A URL to the logo or image of the funding agency. DFG-logo-blau.svg Gold [0..1] 1.10 grantNo An identifying grant number. In case of a publicly funded project, this number is assigned by the funding agency. 501865131 Gold [0..1]"},{"location":"metadata/metadata_key_description/#resource-spatial-keys","title":"Resource - Spatial Keys","text":"# Key Description Example Badge Card. 1 spatial An object that describes the spatial context of the data. [0..1] 1.1 location An object that describes a covered area or region. [0..1] 1.1.1 address An address of the location of the data. May be specified with street name, house number, zip code, and city name. Rudower Chaussee 12, 12489 Berlin Silver [0..1] 1.1.2 @id A path or URI to a specific location. It can use Wikidata or OpenStreetMap. www.wikidata.org/wiki/Q77077223 Platinum [0..1] 1.1.3 longitude The latitude (lat) information of the location. 52.432822 Gold [0..1] 1.1.4 longitude The longitude (lon) information of the location. 13.5351004 Gold [0..1] 1.2 extent An object that describes a covered area or region. [0..1] 1.2.1 name The name of the region. Berlin Silver [0..1] 1.2.2 @id A URI reference for the region. www.wikidata.org/wiki/Q64 Platinum [0..1] 1.2.3 resolutionValue The value of the spatial resolution. 100 Silver [0..1] 1.2.4 resolutionUnit The unit of the spatial resolution. m Silver [0..1] 1.2.5 boundingBox The covered area specified by the coordinates of a bounding box. The format is [minLon, minLat, maxLon, maxLat] or [W,S,E,N]. [13.08825, 52.33859, 13.76104, 52.6754] Gold [*] 1.2.6 crs The Coordinate Reference System, specified as an EPSG code. EPSG:4326 Gold [0..1]"},{"location":"metadata/metadata_key_description/#resource-temporal-keys","title":"Resource - Temporal Keys","text":"# Key Description Example Badge Card. 1 temporal An object with the time period covered in the data. Temporal information should contain either a \"referenceDate\" or the keys that describe a time series, in rare cases both. [0..1] 1.1 referenceDate A base year, month or day. The time for which the data is should be accurate. Date Format is ISO 8601. 2020-01-01 Silver [0..1] 1.2 timeseries An array that describes the timeseries. [*] 1.2.1 start The start time of a time series. 2020-01-01T00:00:00+00:00 Silver [0..1] 1.2.2 end The temporal end point of a time series. 2020-01-01T23:59:30+00:00 Silver [0..1] 1.2.3 resolutionValue The time span between individual information points in a time series. The value of the resolution. 30 s Silver [0..1] 1.2.4 resolutionUnit The unit of the temporal resolution. 30 s Silver [0..1] 1.2.5 alignment An indicator of whether timestamps in a time series are to the left, right or in the centre. left Silver [0..1] 1.2.6 aggregationType An indicator of whether the values are a sum, an average or a current value. current Silver [0..1]"},{"location":"metadata/metadata_key_description/#resource-sources-keys","title":"Resource - Sources Keys","text":"# Key Description Example Badge Card. 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 [0..1] 1.2 authors An array of the full names of the authors of the source material. Hoesung Lee,Jos\u00e9 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 [0..1] 1.4 publicationYear Indicates the year when the work was published. 2023 Bronze [0..1] 1.5 path A DOI or link to the original source. IPCC_AR6_SYR_FullVolume.pdf Bronze [0..1] 1.6 sourceLicenses An array of objects of licenses under which the described source is provided. See academy/courses/08_licensing for further information. [*] 1.6.1 name The SPDX identifier. ODbL-1.0 Bronze [0..1] 1.6.2 title The official (human-readable) title of the license. Open Data Commons Open Database License 1.0 Bronze [0..1] 1.6.3 path A link or path to the license text. opendatacommons.org/licenses/odbl/1-0/index.html Bronze [0..1] 1.6.4 instruction A short description of rights and obligations. The use of tl;drLegal is recommended. You are free to share and change, but you must attribute, and share derivations under the same license. See tldrlegal.com for further information. Bronze [0..1] 1.6.5 attribution A copyright owner of the source. Must be provided if attribution licenses are used. \u00a9 Intergovernmental Panel on Climate Change 2023 Bronze [0..1] 1.6.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. www.ipcc.ch/copyright Bronze [0..1]"},{"location":"metadata/metadata_key_description/#resource-licenses-keys","title":"Resource - Licenses Keys","text":"# Key Description Example Badge Card. 1 licenses An array of objects of licenses under which the described data is provided. [*] 1.1 name The SPDX identifier. ODbL-1.0 Bronze [0..1] 1.2 title The official (human-readable) title of the license. Open Data Commons Open Database License 1.0 Bronze [0..1] 1.3 path A link or path to the license text. opendatacommons.org/licenses/odbl/1-0/index.html Bronze [0..1] 1.4 instruction A short description of rights and obligations. The use of tl;drLegal is recommended. You are free to share and change, but you must attribute, and share derivations under the same license. See tldrlegal.com for further information. Bronze [0..1] 1.5 attribution A copyright owner of the data. Must be provided if attribution licenses are used. \u00a9 Reiner Lemoine Institut Bronze [0..1] 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. www.ipcc.ch/copyright/ Bronze [0..1]"},{"location":"metadata/metadata_key_description/#resource-provenance-keys","title":"Resource - Provenance Keys","text":"# Key Description Example Badge Card. 1 contributors An array of objects of the people or organizations who contributed to the data or metadata. Should have \"Date of data creation\" and \"Date of metadata creation\" [*] 1.1 title A full name of the contributor. Ludwig H\u00fclk Bronze [0..1] 1.2 path A qualified link or path pointing to a relevant location online for the contributor. This can be the GitHub page or ORCID. https://github.com/Ludee Bronze [0..1] 1.3 organization A string describing the organization this contributor is affiliated to. This can be relevant for the copyright. Reiner Lemoine Institut Bronze [0..1] 1.4 roles An array describing the roles of the contributor. A role is recommended to follow the established vocabulary: DataCite Metadata Schema\u2019s contributorRole. Useful roles to indicate are: DataCollector, ContactPerson, and DataCurator. DataCollector, DataCurator Bronze [*] 1.5 date The date of the final contribution. Date Format is ISO 8601. 2024-10-21 Bronze [0..1] 1.6 object The target of the contribution. This can be the data, the metadata or both (data and metadata). data and metadata Bronze [0..1] 1.7 comment A free-text commentary on what has been done. Add general context. Bronze [0..1]"},{"location":"metadata/metadata_key_description/#resource-type-keys","title":"Resource - Type Keys","text":"# Key Description Example Badge Card. 1 type The 'table' type indicates that the resource is tabular as per 'Frictionless Tabular Data' definition. table Gold [0..1] 2 format A file extension format. Possible options are 'csv', 'xlsx', 'json', 'PostgreSQL', 'SQLite' and other standard file extensions. PostgreSQL Gold [0..1] 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 [0..1]"},{"location":"metadata/metadata_key_description/#resource-fields-keys","title":"Resource - Fields Keys","text":"# Key Description Example Badge Card. 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.1 fields An array of objects that describes a field (column) and its detailed information. [1] 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.1.2 description A text describing the field. Reference year for which the data were collected. Silver [0..1] 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.1.4 nullable A boolean key to specify that a column can be nullable. True is the default value. True Iron [1] 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 [0..1] 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 [0..1] 1.1.6.2 @id The path of the ontology term (IRI). OEO_00000044 Platinum [0..1] 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 [0..1] 1.1.7.2 name The class label of the ontology term in the column. onshore wind farm Platinum [0..1] 1.1.7.3 @id The path of the ontology term (IRI) in the column. OEO_00000311 Platinum [0..1]"},{"location":"metadata/metadata_key_description/#resource-properties-keys","title":"Resource - Properties Keys","text":"# Key Description Example Badge Card. 1.2 primaryKey An array of fields that uniquely identifies each row in the table. The default value is the \u201cid\u201d column. id Iron [1..*] 1.3 foreignKeys An array of objects with foreign keys that describe a field that relates to a field in another table. [*] 1.3.1 fields An array of fields in the table that is constrained by the foreign key. id, version Iron [*] 1.3.2 reference The reference to the foreign table. [0..1] 1.3.2.1 resource The referenced foreign table. model_draft.oep_oemetadata_table_example_version Iron [0..1] 1.3.2.2 fields The foreign resource column. id, version Iron [*] 1.4 dialect The Dialect defines a simple format for describing the various dialects of CSV files in a language-independent manner. In a database, the values in the fields are 'null'. [1] 1.4.1 delimiter The delimiter specifies the character sequence which should separate fields (columns). Common characters are ',' (comma), ';' (semicolon), '.' (point) and '\\t' (tab). , Iron [1] 1.4.2 decimalSeparator The symbol used to separate the integer part from the fractional part of a number written in decimal form. Depending on language and region this symbol can be '.' or ','. . Iron [1]"},{"location":"metadata/metadata_key_description/#resource-review-keys","title":"Resource - Review Keys","text":"# Key Description Example Card. 1. review The metadata on the OEP can go through an open peer review process. See the Academy course Open Peer Review for further information. [0..1] 1.1 path A link or path to the documented open peer review. open_peer_review/9 [0..1] 1.2 badge A badge of either Iron, Bronze, Silver, Gold or Platinum is used to label the quality of the metadata. Platinum [0..1]"},{"location":"metadata/metadata_key_description/#metametadata-keys","title":"MetaMetadata Keys","text":"# Key Description Example Card. 1 metaMetadata An object that describes the metadata themselves, their format, version and license. [1] 1.1 metadataVersion Type and version number of the metadata. OEMetadata-2.0 [1] 1.2 metadataLicense The license of the provided metadata. [1] 1.2.1 name The SPDX identifier. CC0-1.0 [1] 1.2.2 title The official (human-readable) title of the license. Creative Commons Zero v1.0 Universal [1] 1.2.3 path A link or path to the license text. creativecommons.org/publicdomain/zero/1.0/ [1]"},{"location":"metadata/metadata_mappings/","title":"Metadata Mappings","text":"n OEMetadata Key Badge Dublin Core DCAT necessity DCAT-AP.de IRI 1 name Iron mandatory dcat:Dataset https://www.dcat-ap.de/def/dcatde/3.0/spec/#klasse-datensatz 2 title Bronze mandatory dcat:Dataset / dct:title https://www.dcat-ap.de/def/dcatde/3.0/spec/#datensatz-titel 3 description Bronze description mandatory dcat:Dataset / dcterms:description https://www.dcat-ap.de/def/dcatde/3.0/spec/#datensatz-beschreibung 4 id Silver identifier optional dcat:Dataset / dct:identifier https://www.dcat-ap.de/def/dcatde/3.0/spec/#datensatz-id 5 resources type mandatory dcat:Distribution https://www.dcat-ap.de/def/dcatde/3.0/spec/#klasse-distribution 6 name Iron mandatory dcat:Distribution / dcat:accessURL https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-zugangs-url 7 topics Bronze coverage mandatory dcat:Distribution / dcat:accessURL https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-zugangs-url 8 title Silver title recommended dcat:Distribution / dcterms:title https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-titel 9 path Bronze identifier mandatory dcat:Distribution / dcat:accessURL https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-zugangs-url 10 description Silver description optional dcat:Distribution / dcterms:description https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-beschreibung 11 languages Gold language optional dcat:Distribution / dcterms:language https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-sprache 12 **subject** subject Datapackage 13 name Platinum recommended dcat:Dataset / dcat:theme https://www.dcat-ap.de/def/dcatde/3.0/spec/#kv-data-theme 14 @id Platinum recommended dcat:Dataset / dcat:theme https://www.dcat-ap.de/def/dcatde/3.0/spec/#kv-data-theme 15 keywords Silver subject recommended dcat:Dataset / dcat:keyword https://www.dcat-ap.de/def/dcatde/3.0/spec/#datensatz-schlagwort 16 publicationDate Bronze date optional dcat:Distribution / dcterms:issued https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-veroffentlichungsdatum 17 **embargoPeriod** Datapackage 18 start Bronze optional OEP 19 end Bronze optional OEP 20 isActive Bronze optional OEP 21 **context** Datapackage 22 title Gold recommended vcard:fn https://www.dcat-ap.de/def/dcatde/3.0/spec/#kontaktinformationen-name 23 homepage Gold recommended vcard:hasURL https://www.dcat-ap.de/def/dcatde/3.0/spec/#kontaktinformationen-url 24 documentation Gold optional dcat:Distribution / foaf:page https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-dokumentation 25 sourceCode Gold optional dcat:Distribution / foaf:page https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-dokumentation 26 contact Gold recommended vcard:hasEmail https://www.dcat-ap.de/def/dcatde/3.0/spec/#kontaktinformationen-email 27 grantNo Gold optional OEP 28 fundingAgency Gold optional OEP 29 fundingAgencyLogo Gold optional foaf:logo http://xmlns.com/foaf/spec/#term_logo 30 publisher Bronze publisher mandatory dcat:Dataset / dcat:publisher https://www.dcat-ap.de/def/dcatde/3.0/spec/#datensatz-herausgeber 31 publisherLogo Gold optional foaf:logo http://xmlns.com/foaf/spec/#term_logo 32 **spatial** coverage Datapackage 33 **location** dcterms:Location https://www.dcat-ap.de/def/dcatde/3.0/spec/#klasse-standort 34 address Silver optional locn:Address / locn:fullAddress https://semiceu.github.io/Core-Location-Vocabulary/releases/2.1.0/#Address 35 @id Platinum optional dcterms:Location / locn:geographicIdentifier https://semiceu.github.io/Core-Location-Vocabulary/releases/2.1.0/#Location.geographicidentifier 36 latitude Gold optional locn:Geometry / latitude https://semiceu.github.io/Core-Location-Vocabulary/releases/2.1.0/#Geometry.latitude 37 longitude Gold optional locn:Geometry / longitude https://semiceu.github.io/Core-Location-Vocabulary/releases/2.1.0/#Geometry.longitude 38 **extent** dcterms:Location https://www.dcat-ap.de/def/dcatde/3.0/spec/#klasse-standort 39 name Silver optional dcterms:Location / geographicName https://semiceu.github.io/Core-Location-Vocabulary/releases/2.1.0/#Location.geographicname 40 @id Platinum optional dcterms:Location / locn:geographicIdentifier https://semiceu.github.io/Core-Location-Vocabulary/releases/2.1.0/#Location.geographicidentifier 41 resolutionValue Silver optional dcat:Distribution / dcat:spatialResolutionInMeters https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-raumliche-auflosung-in-meter 42 resolutionUnit Silver optional dcat:Distribution / dcat:spatialResolutionInMeters https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-raumliche-auflosung-in-meter 43 boundingBox Gold recommended dcterms:Location / dcat:bbox https://www.dcat-ap.de/def/dcatde/3.0/spec/#standort-bounding-box 44 crs Gold optional locn:Geometry / crs https://semiceu.github.io/Core-Location-Vocabulary/releases/2.1.0/#Geometry.crs 45 **temporal** coverage dcterms:PeriodOfTime https://www.dcat-ap.de/def/dcatde/3.0/spec/#klasse-zeitraum 46 referenceDate Silver optional OEP 47 **timeseries** Datapackage 48 start Silver optional dcterms:PeriodOfTime / time:hasBeginning https://www.dcat-ap.de/def/dcatde/3.0/spec/#zeitraum-anfang 49 end Silver optional dcterms:PeriodOfTime / time:hasEnd https://www.dcat-ap.de/def/dcatde/3.0/spec/#zeitraum-ende 50 resolutionValue Silver optional dcat:Distribution / dcat:temporalResolution https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-zeitliche-auflosung 51 resolutionUnit Silver optional dcat:Distribution / dcat:temporalResolution https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-zeitliche-auflosung 52 alignment Gold optional OEP 53 aggregationType Gold optional OEP 54 **sources** source Datapackage 55 title Bronze optional BibTeX title 56 author Bronze optional BibTeX author 57 description Bronze optional BibTeX note 58 publicationYear Bronze optional BibTeX year 59 path Bronze optional BibTeX howpublished 60 **sourceLicenses** Datapackage 61 name Bronze optional OEP https://spdx.org/licenses/ 62 title Bronze optional OEP 63 path Bronze optional dcat:Distribution / dcterms:license https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-lizenz 64 instruction Bronze optional OEP 65 attribution Bronze optional dcat:Distribution / dcatde:licenseAttributionByText https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-namensnennungstext-by-clauses 66 copyrightStatement Bronze optional dcat:Distribution / dcterms:rights https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-rechte 67 **licenses** rights Datapackage 68 name Bronze optional OEP https://spdx.org/licenses/ 69 title Bronze optional OEP 70 path Bronze mandatory dcat:Distribution / dcterms:license https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-lizenz 71 instruction Bronze optional OEP 72 attribution Bronze creator optional dcat:Distribution / dcatde:licenseAttributionByText https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-namensnennungstext-by-clauses 73 **contributors** contributor Datapackage https://www.dcat-ap.de/def/dcatde/3.0/spec/#datensatz-bearbeiter 74 title Bronze optional foaf:name 75 path Bronze optional dcat:Dataset / dcterms:contributor https://www.dcat-ap.de/def/dcatde/3.0/spec/#datensatz-bearbeiter 76 organization Bronze optional foaf:Organization 77 roles Bronze optional dcat:Relationship / dcat:hadRole https://www.dcat-ap.de/def/dcatde/3.0/spec/#beziehung-rolle 78 date Bronze date recommended dcat:Distribution / dcterms:modified https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-aktualisierungsdatum 79 object Bronze optional OEP 80 comment Bronze optional OEP 81 type Gold Datapackage 82 format Gold format recommended dcat:Distribution / dcterms:format https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-format 83 encoding Gold optional OEP 84 **schema** Datapackage 85 **fields** Datapackage 86 name Iron optional OEP 87 description Silver optional OEP 88 type Iron optional OEP 89 nullable Iron optional OEP 90 unit Silver optional OEP 91 **isAbout** Datapackage 92 name Platinum optional OEP 93 @id Platinum optional OEP 94 **valueReference** Datapackage 95 value Platinum optional OEP 96 name Platinum optional OEP 97 @id Platinum optional OEP 98 primaryKey Iron optional OEP 99 **foreignKeys** relation Datapackage 100 fields Iron optional OEP 101 **reference** Datapackage 102 resource Iron optional OEP 103 fields Iron optional OEP 104 **dialect** Datapackage 105 delimiter Iron optional OEP 106 decimalSeparator Iron optional OEP 107 @id Platinum identifier optional OEP 108 @context Platinum optional dcat:Distribution / dcterms:conformsTo https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-konform-zu-standard 109 **review** Datapackage 110 path optional OEP 111 badge optional OEP 112 **metaMetadata** Datapackage 113 metadataVersion optional OEP 114 **metadataLicense** optional OEP 115 name optional OEP 116 title optional OEP 117 path optional OEP"}]} \ No newline at end of file +{"config":{"lang":["en"],"separator":"[\\s\\-,:!=\\[\\]()\"/]+|(?!\\b)(?=[A-Z][a-z])|\\.(?!\\d)|&[lg]t;","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Welcome to the Documentation of the Open Energy Metadata","text":""},{"location":"#open-energy-metadata","title":"Open Energy Metadata","text":"

Open Energy Metadata (OEMetadata) is an energy metadata standard including a metadata schema, templates, and examples. It is an extensive set of metadata based on the Frictionless Data Package specifications and the FAIR Principles.

The documentation is structured in three main sections: - Development Collaborative Development - Metadata Documentation Keys and Mappings - Code Documentation Install, Scripts, Tests

"},{"location":"code/","title":"Functions","text":"

mkdocstrings

This software uses mkdocstings to render docstrings from files.

The code documentation is implemented by writing docstrings. See the mkdocstrings documentation.

"},{"location":"code/install/","title":"Install","text":"
  • requirements.txt
  • requirements_dev.txt
  • environment.yml
  • setup.py
  • pyproject.toml
"},{"location":"code/install/#usage-examples","title":"Usage Examples","text":"

pip install oemetadata

from metadata.latest.example import OEMETADATA_LATEST_EXAMPLE\n\nprint(OEMETADATA_LATEST_EXAMPLE)\n
from metadata.latest.schema import OEMETADATA_LATEST_SCHEMA\n\nprint(OEMETADATA_LATEST_SCHEMA)\n
from metadata.latest.template import OEMETADATA_LATEST_TEMPLATE\n\nprint(OEMETADATA_LATEST_TEMPLATE)\n
"},{"location":"code/style/","title":"Code Style","text":"

Common python styles

  • Pep8
  • https://google.github.io/styleguide/pyguide.html

TBD

"},{"location":"code/tests/","title":"Tests","text":""},{"location":"code/tests/#test-load-file","title":"Test - Load File","text":"

test_FILE_should_load

Warning

\"Cannot open FILE!\"

Solutions: - Check if the file path or name is correct - Check if the test path or name is correct

"},{"location":"code/tests/#test-validate-schema","title":"Test - Validate Schema","text":""},{"location":"code/tests/#validate-oemetadata-schema-with-json-schema","title":"Validate OEMetadata Schema with JSON Schema","text":"

test_jsonschema_should_validate_oemetadata_schema

Warning

\"Cannot validate OEMetadata Schema with JSON Schema (VERSION)!\"

Solutions: - Check if correct JSON Schema has been used - Check if OEMetadata Schema is valid

"},{"location":"code/tests/#validate-file-with-oemetadata-schema","title":"Validate FILE with OEMetadata Schema","text":"

test_oemetadata_schema_should_validate_FILE

Warning

\"Cannot validate FILE with OEMetadata Schema (VERSION)!\"

Solutions: - Check if correct OEMetadata Schema has been used - Check if OEMetadata Schema is valid - Check if FILE is valid

"},{"location":"code/tests/#test-correct-path","title":"Test - Correct path","text":"

test_FILE_should_have_correct_path

Warning

\"Wrong path in FILE (VERSION)!\"

Solutions: - Check if path is correct - Check if test path is correct

"},{"location":"development/collaboration/","title":"Collaboration","text":"

This open-source software is a collaborative effort. The repository has several elements to provide necessary functions.

"},{"location":"development/collaboration/citation/","title":"Citation","text":"

See the Cite this repository function or CITATION.cff for citation of this repository.

"},{"location":"development/collaboration/code_of_conduct/","title":"Code of Conduct","text":"

This repository is following the Contributor Covenant Code of Conduct. Everyone is asked to be self-reflective and always maintain a good culture of discussion and active participation.

"},{"location":"development/collaboration/contributing/","title":"Contributing","text":"

This software is licensed under an open-source license and can be downloaded, executed and modified. To contribute to the collaborative development follow the workflow described in CONTRIBUTING.md.

"},{"location":"development/collaboration/license/","title":"License","text":"

This software is developed under an open-source license. The selected license can be read in the LICENSE.txt.

"},{"location":"development/collaboration/users/","title":"Users","text":"

Known user of this software can be added to USERS.cff for reference.

"},{"location":"development/documentation/","title":"Documentation","text":"
  • README.rst
  • CHANGELOG.md
  • docs/
  • MkDocs
  • mkdocstrings
"},{"location":"development/documentation/#mkdocs","title":"MkDocs","text":"

MkDocs is a fast and simple static site generator that is used for documentation. The source files are written in Markdown, and configured with a single YAML configuration file mkdocs.yml. Material theme enables additional features and an elegant design.

"},{"location":"development/documentation/#install","title":"Install","text":"

Install the required packages in a python environment. pip install mkdocs install MkDocs pip install mkdocs-material install the material theme

"},{"location":"development/documentation/#build","title":"Build","text":"

Generate the documentation. mkdocs serve start the local live version of the documentation mkdocs build create a folder site with the documentation

"},{"location":"development/documentation/#publish","title":"Publish","text":""},{"location":"development/documentation/#manually","title":"Manually","text":"

Publish documentation on GitHub Pages. mkdocs gh-deploy manually deploys the documentation files

"},{"location":"development/documentation/#github-action","title":"GitHub Action","text":"

Deploy the documentation with GitHub Actions. The file .github\\workflows\\gh-pages.yml creates an automated GitHub workflow. It is configured to be pushed to the branch gh-page and then deployed online. A commit on the production branch triggers the workflow.

"},{"location":"development/git/","title":"Git","text":"
  • .gitignore

Copied from (A collection of useful .gitignore templates)[https://github.com/github/gitignore]. For more information about how .gitignore files work, and how to use them, see (Ignoring Files chapter)[https://git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository#_ignoring] of the Pro Git book.

  • issue_template
  • pull_request_template
  • workflows (testing)
"},{"location":"development/git/gitignore/","title":"Gitignore","text":"

Copied from A collection of useful .gitignore templates. For more information about .gitignore files, see the Ignoring Files chapter of the Pro Git book.

"},{"location":"development/release/","title":"Release","text":"

The software release has four main goals:

  1. Merge the new features to the production branch
  2. Create a GitHub Release
  3. Update the documentation
  4. Publish a new version of the package at PyPI

The \ud83d\udcdd RELEASE_PROCEDURE.md contain detailed instructions to do a release.

"},{"location":"metadata/","title":"Metadata Documentation","text":"

Open Energy Metadata (OEMetadata) is a metadata standard for the energy domain. It is an extensive set of metadata based on the Data Package Standard 2.0 and DCAT-AP 3.0 specifications. It is made to facilitate findability, accessibility, interoperability, and reusability (FAIR) of data. A badge system prioritises the keys and serves as a measure of the completeness and quality of the metadata entries.

The metadata schema is defined in JSON schema version 2020-12. The metadata contains keys in a nested JSON structure. The metadata standard includes the following files:

  • schema.json contains the complete metadata schema.
  • metadata_key_description.md contains a full description of each metadata key.
  • template.json contains an empty metadata string with all fields.
  • example.json contains a basic metadata example.
"},{"location":"metadata/metadata_key_description/","title":"Key Description","text":""},{"location":"metadata/metadata_key_description/#oemetadata-key-description","title":"OEMetadata - Key Description","text":"

This pages describes the key of OEMetadata version 2.0 . You can have a look at an empty template and a filled out example of the metadata string. The schema.json contains the complete metadata schema.

"},{"location":"metadata/metadata_key_description/#json-format","title":"JSON Format","text":"

The JSON format offers different formats:

  • key-value pair: JSON {\"key\":\"value\"}
  • array: JSON {\"key\": [\"value\",\"value\"]}
  • object {nested key}: JSON {\"key\": { \"key_a\":\"value\", \"key_b\":\"value\"}}
  • array of objects {nested array}: JSON {\"key\": [ {\"key_a\":\"value\"}, {\"key_a\":\"value\"}]}
"},{"location":"metadata/metadata_key_description/#metadata-keys","title":"Metadata Keys","text":""},{"location":"metadata/metadata_key_description/#cardinality","title":"Cardinality","text":"

The cardinality defines the number of times an element can occur.

  • [1] Mandatory
  • [0..1] Optional
  • [*] Multiple optional
  • [1..*] Mandatory and multiple optional
"},{"location":"metadata/metadata_key_description/#badges","title":"Badges","text":"

Badges indicate the priority of metadata keys. They are implemented as part of the Open Peer Review Process.

"},{"location":"metadata/metadata_key_description/#additional-information","title":"Additional information:","text":"

If a field is not applicable use: null. If a value is not yet available, use: ToDo.

"},{"location":"metadata/metadata_key_description/#collection-keys","title":"Collection Keys","text":"# Key Description Example Badge Card. 1 @context Explanation of metadata keys in ontology terms. context.json Platinum [0..1] 2 name A filename or database conform dataset name. oep_oemetadata Iron [1] 3 title A human readable dataset name. OEP OEMetadata Bronze [0..1] 4 description A free text description of the dataset. A collection of tables for the OEMetadata examples. Bronze [0..1] 5 id A unique identifier (UUID/DOI) for the dataset. databus.openenergyplatform.org/oeplatform Silver [0..1] 6 resources An array of objects of the resources. The dataset can contain several (database) tables. [*]"},{"location":"metadata/metadata_key_description/#resource-general-keys","title":"Resource - General Keys","text":"# Key Description Example Badge Card. 1 @id A Uniform Resource Identifier (URI) that links the resource via the OpenEnergyDatabus (DBpedia Databus). wri_global_power_plant_database Platinum [0..1] 2 name A filename or database conform table name. oemetadata_table_template Iron [1] 3 topics An array of predefined topics that correspond to the database schemas of the OEP. model_draft Bronze [*] 4 title A human readable table name. OEMetadata Table Template Silver [0..1] 5 path A unique identifier (URI/UUID/DOI) for the table or file. model_draft/oemetadata_table_template Bronze [0..1] 6 description A description of the table. It should be usable as summary information for the table that is described by the metadata. Example table used to illustrate the OEMetadata structure and features. Silver [0..1] 7 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 Gold [*] 8 subject An array of objects that references to the subjects of the resource in ontology terms. [*] 8.1 name A class label of the ontology term. energy Platinum [0..1] 8.2 @id A unique identifier (URI/IRI) of the ontology class. openenergyplatform.org/ontology/oeo/OEO_00000150 Platinum [0..1] 9 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 [*] 10 publicationDate A date of publication of the data or metadata. The date format is ISO 8601 (YYYY-MM-DD). 2024-10-15 Bronze [0..1] 11 embargoPeriod An object that describes the embargo period during which public access to the data is not allowed. [0..1] 11.1 start The start date of the embargo period. The date of the data (metadata) upload. 2024-10-11 Bronze [0..1] 11.2 end The end date of the embargo period. This is the envisioned publication date. 2025-01-01 Bronze [0..1] 11.3 isActive A boolean key that indicates if the embargo period is currently active. Must be changed to False on the embargo period end date. True Bronze [0..1]"},{"location":"metadata/metadata_key_description/#resource-context-keys","title":"Resource - Context Keys","text":"# Key Description Example Badge Card. 1 context An object that describes the general setting, environment, or project leading to the creation or maintenance of this dataset. In science this is can be the research project. [0..1] 1.1 title A title of the associated project. NFDI4Energy Gold [0..1] 1.2 homepage A URL of the project. nfdi4energy.uol.de Gold [0..1] 1.3 documentation A URL of the project documentation. nfdi4energy.uol.de/sites/about_us Gold [0..1] 1.4 sourceCode A URL of the source code of the project. github.com/NFDI4Energy Gold [0..1] 1.5 publisher The publishing agency of the data. This can be the OEP. Open Energy Platform (OEP) Gold [0..1] 1.6 publisherLogo A URL to the logo of the publishing agency of data. OpenEnergyFamily_Logo_OpenEnergyPlatform.svg Gold [0..1] 1.7 contact A reference to the creator or maintainer of the data set. It can be an email address or a GitHub handle. info@nfdi4energy.org Gold [0..1] 1.8 fundingAgency A name of the entity providing the funding. This can be a government agency or a company. Deutsche Forschungsgemeinschaft (DFG) Gold [0..1] 1.9 fundingAgencyLogo A URL to the logo or image of the funding agency. DFG-logo-blau.svg Gold [0..1] 1.10 grantNo An identifying grant number. In case of a publicly funded project, this number is assigned by the funding agency. 501865131 Gold [0..1]"},{"location":"metadata/metadata_key_description/#resource-spatial-keys","title":"Resource - Spatial Keys","text":"# Key Description Example Badge Card. 1 spatial An object that describes the spatial context of the data. [0..1] 1.1 location An object that describes a covered area or region. [0..1] 1.1.1 address An address of the location of the data. May be specified with street name, house number, zip code, and city name. Rudower Chaussee 12, 12489 Berlin Silver [0..1] 1.1.2 @id A path or URI to a specific location. It can use Wikidata or OpenStreetMap. www.wikidata.org/wiki/Q77077223 Platinum [0..1] 1.1.3 longitude The latitude (lat) information of the location. 52.432822 Gold [0..1] 1.1.4 longitude The longitude (lon) information of the location. 13.5351004 Gold [0..1] 1.2 extent An object that describes a covered area or region. [0..1] 1.2.1 name The name of the region. Berlin Silver [0..1] 1.2.2 @id A URI reference for the region. www.wikidata.org/wiki/Q64 Platinum [0..1] 1.2.3 resolutionValue The value of the spatial resolution. 100 Silver [0..1] 1.2.4 resolutionUnit The unit of the spatial resolution. m Silver [0..1] 1.2.5 boundingBox The covered area specified by the coordinates of a bounding box. The format is [minLon, minLat, maxLon, maxLat] or [W,S,E,N]. [13.08825, 52.33859, 13.76104, 52.6754] Gold [*] 1.2.6 crs The Coordinate Reference System, specified as an EPSG code. EPSG:4326 Gold [0..1]"},{"location":"metadata/metadata_key_description/#resource-temporal-keys","title":"Resource - Temporal Keys","text":"# Key Description Example Badge Card. 1 temporal An object with the time period covered in the data. Temporal information should contain either a \"referenceDate\" or the keys that describe a time series, in rare cases both. [0..1] 1.1 referenceDate A base year, month or day. The time for which the data is should be accurate. Date Format is ISO 8601. 2020-01-01 Silver [0..1] 1.2 timeseries An array that describes the timeseries. [*] 1.2.1 start The start time of a time series. 2020-01-01T00:00:00+00:00 Silver [0..1] 1.2.2 end The temporal end point of a time series. 2020-01-01T23:59:30+00:00 Silver [0..1] 1.2.3 resolutionValue The time span between individual information points in a time series. The value of the resolution. 30 s Silver [0..1] 1.2.4 resolutionUnit The unit of the temporal resolution. 30 s Silver [0..1] 1.2.5 alignment An indicator of whether timestamps in a time series are to the left, right or in the centre. left Silver [0..1] 1.2.6 aggregationType An indicator of whether the values are a sum, an average or a current value. current Silver [0..1]"},{"location":"metadata/metadata_key_description/#resource-sources-keys","title":"Resource - Sources Keys","text":"# Key Description Example Badge Card. 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 [0..1] 1.2 authors An array of the full names of the authors of the source material. Hoesung Lee,Jos\u00e9 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 [0..1] 1.4 publicationYear Indicates the year when the work was published. 2023 Bronze [0..1] 1.5 path A DOI or link to the original source. IPCC_AR6_SYR_FullVolume.pdf Bronze [0..1] 1.6 sourceLicenses An array of objects of licenses under which the described source is provided. See academy/courses/08_licensing for further information. [*] 1.6.1 name The SPDX identifier. ODbL-1.0 Bronze [0..1] 1.6.2 title The official (human-readable) title of the license. Open Data Commons Open Database License 1.0 Bronze [0..1] 1.6.3 path A link or path to the license text. opendatacommons.org/licenses/odbl/1-0/index.html Bronze [0..1] 1.6.4 instruction A short description of rights and obligations. The use of tl;drLegal is recommended. You are free to share and change, but you must attribute, and share derivations under the same license. See tldrlegal.com for further information. Bronze [0..1] 1.6.5 attribution A copyright owner of the source. Must be provided if attribution licenses are used. \u00a9 Intergovernmental Panel on Climate Change 2023 Bronze [0..1] 1.6.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. www.ipcc.ch/copyright Bronze [0..1]"},{"location":"metadata/metadata_key_description/#resource-licenses-keys","title":"Resource - Licenses Keys","text":"# Key Description Example Badge Card. 1 licenses An array of objects of licenses under which the described data is provided. [*] 1.1 name The SPDX identifier. ODbL-1.0 Bronze [0..1] 1.2 title The official (human-readable) title of the license. Open Data Commons Open Database License 1.0 Bronze [0..1] 1.3 path A link or path to the license text. opendatacommons.org/licenses/odbl/1-0/index.html Bronze [0..1] 1.4 instruction A short description of rights and obligations. The use of tl;drLegal is recommended. You are free to share and change, but you must attribute, and share derivations under the same license. See tldrlegal.com for further information. Bronze [0..1] 1.5 attribution A copyright owner of the data. Must be provided if attribution licenses are used. \u00a9 Reiner Lemoine Institut Bronze [0..1] 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. www.ipcc.ch/copyright/ Bronze [0..1]"},{"location":"metadata/metadata_key_description/#resource-provenance-keys","title":"Resource - Provenance Keys","text":"# Key Description Example Badge Card. 1 contributors An array of objects of the people or organizations who contributed to the data or metadata. Should have \"Date of data creation\" and \"Date of metadata creation\" [*] 1.1 title A full name of the contributor. Ludwig H\u00fclk Bronze [0..1] 1.2 path A qualified link or path pointing to a relevant location online for the contributor. This can be the GitHub page or ORCID. https://github.com/Ludee Bronze [0..1] 1.3 organization A string describing the organization this contributor is affiliated to. This can be relevant for the copyright. Reiner Lemoine Institut Bronze [0..1] 1.4 roles An array describing the roles of the contributor. A role is recommended to follow the established vocabulary: DataCite Metadata Schema\u2019s contributorRole. Useful roles to indicate are: DataCollector, ContactPerson, and DataCurator. DataCollector, DataCurator Bronze [*] 1.5 date The date of the final contribution. Date Format is ISO 8601. 2024-10-21 Bronze [0..1] 1.6 object The target of the contribution. This can be the data, the metadata or both (data and metadata). data and metadata Bronze [0..1] 1.7 comment A free-text commentary on what has been done. Add general context. Bronze [0..1]"},{"location":"metadata/metadata_key_description/#resource-type-keys","title":"Resource - Type Keys","text":"# Key Description Example Badge Card. 1 type The 'table' type indicates that the resource is tabular as per 'Frictionless Tabular Data' definition. table Gold [0..1] 2 format A file extension format. Possible options are 'csv', 'xlsx', 'json', 'PostgreSQL', 'SQLite' and other standard file extensions. PostgreSQL Gold [0..1] 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 [0..1]"},{"location":"metadata/metadata_key_description/#resource-fields-keys","title":"Resource - Fields Keys","text":"# Key Description Example Badge Card. 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.1 fields An array of objects that describes a field (column) and its detailed information. [1] 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.1.2 description A text describing the field. Reference year for which the data were collected. Silver [0..1] 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.1.4 nullable A boolean key to specify that a column can be nullable. True is the default value. True Iron [1] 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 [0..1] 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 [0..1] 1.1.6.2 @id The path of the ontology term (IRI). OEO_00000044 Platinum [0..1] 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 [0..1] 1.1.7.2 name The class label of the ontology term in the column. onshore wind farm Platinum [0..1] 1.1.7.3 @id The path of the ontology term (IRI) in the column. OEO_00000311 Platinum [0..1]"},{"location":"metadata/metadata_key_description/#resource-properties-keys","title":"Resource - Properties Keys","text":"# Key Description Example Badge Card. 1.2 primaryKey An array of fields that uniquely identifies each row in the table. The default value is the \u201cid\u201d column. id Iron [1..*] 1.3 foreignKeys An array of objects with foreign keys that describe a field that relates to a field in another table. [*] 1.3.1 fields An array of fields in the table that is constrained by the foreign key. id, version Iron [*] 1.3.2 reference The reference to the foreign table. [0..1] 1.3.2.1 resource The referenced foreign table. model_draft.oep_oemetadata_table_example_version Iron [0..1] 1.3.2.2 fields The foreign resource column. id, version Iron [*] 1.4 dialect The Dialect defines a simple format for describing the various dialects of CSV files in a language-independent manner. In a database, the values in the fields are 'null'. [1] 1.4.1 delimiter The delimiter specifies the character sequence which should separate fields (columns). Common characters are ',' (comma), ';' (semicolon), '.' (point) and '\\t' (tab). , Iron [1] 1.4.2 decimalSeparator The symbol used to separate the integer part from the fractional part of a number written in decimal form. Depending on language and region this symbol can be '.' or ','. . Iron [1]"},{"location":"metadata/metadata_key_description/#resource-review-keys","title":"Resource - Review Keys","text":"# Key Description Example Card. 1. review The metadata on the OEP can go through an open peer review process. See the Academy course Open Peer Review for further information. [0..1] 1.1 path A link or path to the documented open peer review. open_peer_review/9 [0..1] 1.2 badge A badge of either Iron, Bronze, Silver, Gold or Platinum is used to label the quality of the metadata. Platinum [0..1]"},{"location":"metadata/metadata_key_description/#metametadata-keys","title":"MetaMetadata Keys","text":"# Key Description Example Card. 1 metaMetadata An object that describes the metadata themselves, their format, version and license. [1] 1.1 metadataVersion Type and version number of the metadata. OEMetadata-2.0 [1] 1.2 metadataLicense The license of the provided metadata. [1] 1.2.1 name The SPDX identifier. CC0-1.0 [1] 1.2.2 title The official (human-readable) title of the license. Creative Commons Zero v1.0 Universal [1] 1.2.3 path A link or path to the license text. creativecommons.org/publicdomain/zero/1.0/ [1]"},{"location":"metadata/metadata_mappings/","title":"Metadata Mappings","text":"n OEMetadata Key Badge Dublin Core DCAT necessity DCAT-AP.de IRI 1 name Iron mandatory dcat:Dataset https://www.dcat-ap.de/def/dcatde/3.0/spec/#klasse-datensatz 2 title Bronze mandatory dcat:Dataset / dct:title https://www.dcat-ap.de/def/dcatde/3.0/spec/#datensatz-titel 3 description Bronze description mandatory dcat:Dataset / dcterms:description https://www.dcat-ap.de/def/dcatde/3.0/spec/#datensatz-beschreibung 4 id Silver identifier optional dcat:Dataset / dct:identifier https://www.dcat-ap.de/def/dcatde/3.0/spec/#datensatz-id 5 resources type mandatory dcat:Distribution https://www.dcat-ap.de/def/dcatde/3.0/spec/#klasse-distribution 6 name Iron mandatory dcat:Distribution / dcat:accessURL https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-zugangs-url 7 topics Bronze coverage mandatory dcat:Distribution / dcat:accessURL https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-zugangs-url 8 title Silver title recommended dcat:Distribution / dcterms:title https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-titel 9 path Bronze identifier mandatory dcat:Distribution / dcat:accessURL https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-zugangs-url 10 description Silver description optional dcat:Distribution / dcterms:description https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-beschreibung 11 languages Gold language optional dcat:Distribution / dcterms:language https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-sprache 12 **subject** subject Datapackage 13 name Platinum recommended dcat:Dataset / dcat:theme https://www.dcat-ap.de/def/dcatde/3.0/spec/#kv-data-theme 14 @id Platinum recommended dcat:Dataset / dcat:theme https://www.dcat-ap.de/def/dcatde/3.0/spec/#kv-data-theme 15 keywords Silver subject recommended dcat:Dataset / dcat:keyword https://www.dcat-ap.de/def/dcatde/3.0/spec/#datensatz-schlagwort 16 publicationDate Bronze date optional dcat:Distribution / dcterms:issued https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-veroffentlichungsdatum 17 **embargoPeriod** Datapackage 18 start Bronze optional OEP 19 end Bronze optional OEP 20 isActive Bronze optional OEP 21 **context** Datapackage 22 title Gold recommended vcard:fn https://www.dcat-ap.de/def/dcatde/3.0/spec/#kontaktinformationen-name 23 homepage Gold recommended vcard:hasURL https://www.dcat-ap.de/def/dcatde/3.0/spec/#kontaktinformationen-url 24 documentation Gold optional dcat:Distribution / foaf:page https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-dokumentation 25 sourceCode Gold optional dcat:Distribution / foaf:page https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-dokumentation 26 contact Gold recommended vcard:hasEmail https://www.dcat-ap.de/def/dcatde/3.0/spec/#kontaktinformationen-email 27 grantNo Gold optional OEP 28 fundingAgency Gold optional OEP 29 fundingAgencyLogo Gold optional foaf:logo http://xmlns.com/foaf/spec/#term_logo 30 publisher Bronze publisher mandatory dcat:Dataset / dcat:publisher https://www.dcat-ap.de/def/dcatde/3.0/spec/#datensatz-herausgeber 31 publisherLogo Gold optional foaf:logo http://xmlns.com/foaf/spec/#term_logo 32 **spatial** coverage Datapackage 33 **location** dcterms:Location https://www.dcat-ap.de/def/dcatde/3.0/spec/#klasse-standort 34 address Silver optional locn:Address / locn:fullAddress https://semiceu.github.io/Core-Location-Vocabulary/releases/2.1.0/#Address 35 @id Platinum optional dcterms:Location / locn:geographicIdentifier https://semiceu.github.io/Core-Location-Vocabulary/releases/2.1.0/#Location.geographicidentifier 36 latitude Gold optional locn:Geometry / latitude https://semiceu.github.io/Core-Location-Vocabulary/releases/2.1.0/#Geometry.latitude 37 longitude Gold optional locn:Geometry / longitude https://semiceu.github.io/Core-Location-Vocabulary/releases/2.1.0/#Geometry.longitude 38 **extent** dcterms:Location https://www.dcat-ap.de/def/dcatde/3.0/spec/#klasse-standort 39 name Silver optional dcterms:Location / geographicName https://semiceu.github.io/Core-Location-Vocabulary/releases/2.1.0/#Location.geographicname 40 @id Platinum optional dcterms:Location / locn:geographicIdentifier https://semiceu.github.io/Core-Location-Vocabulary/releases/2.1.0/#Location.geographicidentifier 41 resolutionValue Silver optional dcat:Distribution / dcat:spatialResolutionInMeters https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-raumliche-auflosung-in-meter 42 resolutionUnit Silver optional dcat:Distribution / dcat:spatialResolutionInMeters https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-raumliche-auflosung-in-meter 43 boundingBox Gold recommended dcterms:Location / dcat:bbox https://www.dcat-ap.de/def/dcatde/3.0/spec/#standort-bounding-box 44 crs Gold optional locn:Geometry / crs https://semiceu.github.io/Core-Location-Vocabulary/releases/2.1.0/#Geometry.crs 45 **temporal** coverage dcterms:PeriodOfTime https://www.dcat-ap.de/def/dcatde/3.0/spec/#klasse-zeitraum 46 referenceDate Silver optional OEP 47 **timeseries** Datapackage 48 start Silver optional dcterms:PeriodOfTime / time:hasBeginning https://www.dcat-ap.de/def/dcatde/3.0/spec/#zeitraum-anfang 49 end Silver optional dcterms:PeriodOfTime / time:hasEnd https://www.dcat-ap.de/def/dcatde/3.0/spec/#zeitraum-ende 50 resolutionValue Silver optional dcat:Distribution / dcat:temporalResolution https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-zeitliche-auflosung 51 resolutionUnit Silver optional dcat:Distribution / dcat:temporalResolution https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-zeitliche-auflosung 52 alignment Gold optional OEP 53 aggregationType Gold optional OEP 54 **sources** source Datapackage 55 title Bronze optional BibTeX title 56 author Bronze optional BibTeX author 57 description Bronze optional BibTeX note 58 publicationYear Bronze optional BibTeX year 59 path Bronze optional BibTeX howpublished 60 **sourceLicenses** Datapackage 61 name Bronze optional OEP https://spdx.org/licenses/ 62 title Bronze optional OEP 63 path Bronze optional dcat:Distribution / dcterms:license https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-lizenz 64 instruction Bronze optional OEP 65 attribution Bronze optional dcat:Distribution / dcatde:licenseAttributionByText https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-namensnennungstext-by-clauses 66 copyrightStatement Bronze optional dcat:Distribution / dcterms:rights https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-rechte 67 **licenses** rights Datapackage 68 name Bronze optional OEP https://spdx.org/licenses/ 69 title Bronze optional OEP 70 path Bronze mandatory dcat:Distribution / dcterms:license https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-lizenz 71 instruction Bronze optional OEP 72 attribution Bronze creator optional dcat:Distribution / dcatde:licenseAttributionByText https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-namensnennungstext-by-clauses 73 **contributors** contributor Datapackage https://www.dcat-ap.de/def/dcatde/3.0/spec/#datensatz-bearbeiter 74 title Bronze optional foaf:name 75 path Bronze optional dcat:Dataset / dcterms:contributor https://www.dcat-ap.de/def/dcatde/3.0/spec/#datensatz-bearbeiter 76 organization Bronze optional foaf:Organization 77 roles Bronze optional dcat:Relationship / dcat:hadRole https://www.dcat-ap.de/def/dcatde/3.0/spec/#beziehung-rolle 78 date Bronze date recommended dcat:Distribution / dcterms:modified https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-aktualisierungsdatum 79 object Bronze optional OEP 80 comment Bronze optional OEP 81 type Gold Datapackage 82 format Gold format recommended dcat:Distribution / dcterms:format https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-format 83 encoding Gold optional OEP 84 **schema** Datapackage 85 **fields** Datapackage 86 name Iron optional OEP 87 description Silver optional OEP 88 type Iron optional OEP 89 nullable Iron optional OEP 90 unit Silver optional OEP 91 **isAbout** Datapackage 92 name Platinum optional OEP 93 @id Platinum optional OEP 94 **valueReference** Datapackage 95 value Platinum optional OEP 96 name Platinum optional OEP 97 @id Platinum optional OEP 98 primaryKey Iron optional OEP 99 **foreignKeys** relation Datapackage 100 fields Iron optional OEP 101 **reference** Datapackage 102 resource Iron optional OEP 103 fields Iron optional OEP 104 **dialect** Datapackage 105 delimiter Iron optional OEP 106 decimalSeparator Iron optional OEP 107 @id Platinum identifier optional OEP 108 @context Platinum optional dcat:Distribution / dcterms:conformsTo https://www.dcat-ap.de/def/dcatde/3.0/spec/#distribution-konform-zu-standard 109 **review** Datapackage 110 path optional OEP 111 badge optional OEP 112 **metaMetadata** Datapackage 113 metadataVersion optional OEP 114 **metadataLicense** optional OEP 115 name optional OEP 116 title optional OEP 117 path optional OEP"}]} \ No newline at end of file