From fbc6cf11ac838eb3cb1bbc3d778015e0d9868e1b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotr=20Sowi=C5=84ski?= Date: Wed, 15 Jan 2025 21:39:36 +0100 Subject: [PATCH] Initial commit --- .github/workflows/release.yaml | 19 +++++++ .github/workflows/validate.yaml | 11 ++++ LICENSE | 5 ++ README.md | 5 ++ metadata.ttl | 99 +++++++++++++++++++++++++++++++++ 5 files changed, 139 insertions(+) create mode 100644 .github/workflows/release.yaml create mode 100644 .github/workflows/validate.yaml create mode 100644 LICENSE create mode 100644 README.md create mode 100644 metadata.ttl diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml new file mode 100644 index 0000000..fee5d7b --- /dev/null +++ b/.github/workflows/release.yaml @@ -0,0 +1,19 @@ +name: "Release" +on: + push: + branches: + - main + tags: + - "v*" + workflow_dispatch: {} + +jobs: + validate: + uses: RiverBench/ci-workflows/.github/workflows/dataset-validate.yaml@main + secrets: inherit + + release: + uses: RiverBench/ci-workflows/.github/workflows/dataset-release.yaml@main + needs: validate + permissions: write-all + secrets: inherit diff --git a/.github/workflows/validate.yaml b/.github/workflows/validate.yaml new file mode 100644 index 0000000..a3e679f --- /dev/null +++ b/.github/workflows/validate.yaml @@ -0,0 +1,11 @@ +name: "Validate" +on: + pull_request: + branches: + - main + workflow_dispatch: {} + +jobs: + validate: + uses: RiverBench/ci-workflows/.github/workflows/dataset-validate.yaml@main + secrets: inherit diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..7576c7a --- /dev/null +++ b/LICENSE @@ -0,0 +1,5 @@ +PLACE HERE YOUR LICENSING INFORMATION + +LICENSE TEMPLATES: https://github.com/licenses/license-templates/tree/master/templates + +MORE TEMPLATES: https://github.com/spdx/license-list-data/tree/main/text diff --git a/README.md b/README.md new file mode 100644 index 0000000..f19bcbc --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +# dataset-template + +Template for new datasets. See the [guide on creating new datasets](https://w3id.org/riverbench/documentation/creating-new-dataset) for information on how to use it. + +Do not edit this README. It will be overwritten automatically when you complete setting up the dataset's metadata. diff --git a/metadata.ttl b/metadata.ttl new file mode 100644 index 0000000..495b8a2 --- /dev/null +++ b/metadata.ttl @@ -0,0 +1,99 @@ +@prefix : . +@prefix dcat: . +@prefix dcterms: . +@prefix eurovoc: . +@prefix foaf: . +@prefix rb: . +@prefix rbdoc: . +@prefix rdfs: . +@prefix sh: . +@prefix spdx: . +@prefix stax: . +@prefix void: . +@prefix xsd: . + +# This file contains the manually written metadata for the dataset. +# The IRI of the dataset here is temporary. Real IRIs are assigned +# automatically in CI. + +:dataset + a rb:Dataset, dcat:Dataset ; + dcterms:conformsTo ; + dcterms:identifier "[YOUR DATASET ID (only a-z, 0-9, -)]" ; + + dcterms:title "[HUMAN-READABLE NAME OF YOUR DATASET]"@en ; + dcterms:description """[ELABORATED DESCRIPTION OF THE DATASET]"""@en ; + dcterms:issued "[DATE OF INITIAL SUBMISSION TO RIVERBENCH, YYYY-MM-DD]"^^xsd:date ; + + # License and attribution + # SPDX license list: https://spdx.org/licenses/ + # Do not include ".html" at the end of the SPDX license URL + # Example of a valid URL: https://spdx.org/licenses/CC-BY-4.0 + dcterms:license ; + dcterms:rights "[ADDITIONAL LICENSING NOTES, IF NEEDED, OTHERWISE REMOVE THIS]"@en ; + # Feel free to add more creators or use any FOAF properties here + # All fields are optional, but at least one creator is required + dcterms:creator [ + foaf:name "[YOUR NAME]" ; + foaf:nick "[YOUR NICK]" ; + foaf:homepage ; + rdfs:comment "[EXPLAIN, E.G., YOUR ROLE IN THE DATASET CREATION]"@en ; + # Use this property to order creators in the generated docs (from 1 to N) + rbdoc:hasDocWeight 1 ; + ] ; + # If applicable, add a link or multiples links to the original source of the dataset + dcterms:source ; + + # Themes from EuroVoc + # E.g., eurovoc:4267, eurovoc:7219 + # Use only concepts (those without numbers in their names), + # not domain concepts or concept schemes. + # EuroVoc browser: https://op.europa.eu/en/web/eu-vocabularies/concept-scheme/-/resource?IRI=http://eurovoc.europa.eu/100141 + dcat:theme eurovoc:ADD-AT-LEAST-ONE-THEME ; + + # Technical metadata + # IRIs of the vocabularies and ontologies used in the dataset + void:vocabulary ; + # Set to number of stream elements in the dataset + rb:hasStreamElementCount -1 ; + # Stream type according to the RDF Stream Taxonomy (RDF-STaX) + # Each dataset must have two stream type usages: one for the grouped + # stream type and one for the flat stream type. + # Full list of stream types: https://w3id.org/stax/dev/taxonomy/ + stax:hasStreamTypeUsage [ + a stax:RdfStreamTypeUsage ; + rdfs:comment "[GROUPED STREAM TYPE EXPLANATION]"@en ; + stax:hasStreamType stax:GROUPED-STREAM-TYPE-IRI ; + ] , [ + a stax:RdfStreamTypeUsage ; + rdfs:comment "[FLAT STREAM TYPE EXPLANATION]"@en ; + stax:hasStreamType stax:FLAT-STREAM-TYPE-IRI ; + ] ; + rb:hasStreamElementSplit [ + # At least one of: rb:StatementCountStreamElementSplit, + # rb:TimeStreamElementSplit, rb:TopicStreamElementSplit + a ; + + # If your dataset is split by time, you must specify the temporal property. + # Example: https://github.com/RiverBench/dataset-assist-iot-weather-graphs/blob/main/metadata.ttl + # rb:hasTemporalProperty ; + + rdfs:comment "[FURTHER EXPLANATION ON THE SPLIT]"@en ; + + # If your dataset is an RDF subject graph stream, you must specify the + # subject node shape using SHACL. + # Example: https://github.com/RiverBench/dataset-linked-spending/blob/main/metadata.ttl + # SHACL documentation: https://www.w3.org/TR/shacl/#constraints-section + # rb:hasSubjectShape [ ] ; + ] ; + rb:conformsToRdf11 "" ; # true or false + rb:conformsToRdfStarDraft_20211217 "" ; # true or false + rb:usesGeneralizedRdfDatasets "" ; # true or false + rb:usesGeneralizedTriples "" ; # true or false + rb:usesRdfStar "" ; # true or false + + # Add any additional metadata here + # Examples of useful properties: + # dcat:temporalResolution, dcat:spatialResolutionInMeters, + # dcterms:language +.