diff --git a/2.0/404.html b/2.0/404.html index 5d717e59..fbfc3beb 100755 --- a/2.0/404.html +++ b/2.0/404.html @@ -1034,6 +1034,8 @@ + + @@ -1050,16 +1052,19 @@ -
The JSON format offers different formats:
The cardinality defines the number of times an element can occur.
+Badges indicate the priority of metadata keys.
+They are implemented as part of the Open Peer Review Process.
If a field is not applicable use: null
.
If a value is not yet available, use: ToDo
.
# | -Key | -Description | -Example | -Badge | +# |
+Key |
+Description |
+Example |
+Badge |
+Card. |
---|---|---|---|---|---|---|---|---|---|---|
1 | name | -A filename or database conform collection name. | +A filename or database conform dataset name. | oep_oemetadata | Iron | +[1] | ||||
2 | title | -A human readable collection name. | +A human readable dataset name. | OEP OEMetadata | Bronze | +[0..1] | ||||
3 | description | -A free text description of the collection. | +A free text description of the dataset. | A collection of tables for the OEMetadata examples. | Bronze | +[0..1] | ||||
4 | id | -A unique identifier (UUID/DOI) for the collection. | -https://databus.openenergyplatform.org/oeplatform/reference | +A unique identifier (UUID/DOI) for the dataset. | +databus.openenergyplatform.org/oeplatform | Silver | +[0..1] | |||
5 | resources | -An array of objects of the resources. The collection can contain several (database) tables. | +An array of objects of the resources. The dataset can contain several (database) tables. | + | [*] |
Open Energy Metadata (OEMetadata) is an energy metadata standard including a template, examples and a metadata schema. It is an extensive set of metadata based on the tabular data package specifications and the FAIR principles. The metadata contains multiple fields (keys) in a nested JSON structure.
"},{"location":"#documentation-structure","title":"Documentation Structure","text":"The documentation is separated into two main sections: Development
and Metadata Documentation
.
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":"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
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":"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.
Install the required packages in a python environment. pip install mkdocs
install MkDocs pip install mkdocs-material
install the material theme
Generate the documentation. mkdocs serve
start the local live version of the documentation mkdocs build
create a folder site
with the documentation
Publish documentation on GitHub Pages. mkdocs gh-deploy
manually deploys the documentation files
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.
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.
Copied from A collection of useful .gitignore templates. For more information about .gitignore
files, see the Ignoring Files chapter of the Pro Git book.
See the complete instructions in the RELEASE_PROCEDURE.
"},{"location":"development/release/#make-pypi-release","title":"Make PyPI release:","text":"First update version in setup.py, then:
python3 setup.py sdist bdist_wheel\ntwine upload dist/*\n
"},{"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:
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. schema.json
contains the complete schema.
The JSON format offers different formats:
JSON {\"key\":\"value\"}
JSON {\"key\": [\"value\",\"value\"]}
JSON {\"key\": { \"key_a\":\"value\", \"key_b\":\"value\"}}
JSON {\"key\": [ {\"key_a\":\"value\"}, {\"key_a\":\"value\"}]}
If a field is not applicable use: null
. If a value is not yet available, use: ToDo
.
Open Energy Metadata (OEMetadata) is an energy metadata standard including a template, examples and a metadata schema. It is an extensive set of metadata based on the tabular data package specifications and the FAIR principles. The metadata contains multiple fields (keys) in a nested JSON structure.
"},{"location":"#documentation-structure","title":"Documentation Structure","text":"The documentation is separated into two main sections: Development
and Metadata Documentation
.
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":"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
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":"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.
Install the required packages in a python environment. pip install mkdocs
install MkDocs pip install mkdocs-material
install the material theme
Generate the documentation. mkdocs serve
start the local live version of the documentation mkdocs build
create a folder site
with the documentation
Publish documentation on GitHub Pages. mkdocs gh-deploy
manually deploys the documentation files
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.
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.
Copied from A collection of useful .gitignore templates. For more information about .gitignore
files, see the Ignoring Files chapter of the Pro Git book.
The software release has four main goals:
production
branchThe \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:
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.
The JSON format offers different formats:
JSON {\"key\":\"value\"}
JSON {\"key\": [\"value\",\"value\"]}
JSON {\"key\": { \"key_a\":\"value\", \"key_b\":\"value\"}}
JSON {\"key\": [ {\"key_a\":\"value\"}, {\"key_a\":\"value\"}]}
The cardinality defines the number of times an element can occur.
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
.