Commit 53d9f121 authored by Susanne Arndt's avatar Susanne Arndt
Browse files

Merge branch '21-add-readme-files-to-all-sub-directories-of-project' into 'main'

Resolve "Add README files to all sub-directories of project"

Closes #21

See merge request !17
parents 40a75151 737daa4c
Pipeline #70640 canceled with stages
......@@ -50,7 +50,7 @@ pages:
- echo "Creating documentation..."
- mkdir doc
- wget https://github.com/dgarijo/Widoco/releases/download/v$WIDOCO_VERSION/widoco-$WIDOCO_VERSION-jar-with-dependencies.jar -O widoco.jar
- java -jar widoco.jar -ontFile myOnto.ttl -outFolder doc -webVowl -uniteSections -oops -rewriteAll -confFile config.properties
- java -jar widoco.jar -ontFile myOnto.ttl -outFolder doc -webVowl -uniteSections -oops -rewriteAll -confFile widoco_sections/config.properties
- ls -al doc
- mv doc/ontology.rdf doc/ontology.xml
- mv doc/OOPSevaluation doc/OOPSEvaluation
......
# ListDB Ontology
This is an ontology draft for the description of metadata of traffic observations, in particular video recordings of road traffic. The traffic observations are e.g. used to design test scenarios for the effectiveness assessment of automated driving systems.
This is an ontology draft for the description of metadata of traffic observations, in particular video recordings of road traffic. The traffic observations are e.g. used to design test scenarios for the effectiveness assessment of automated driving systems.
The ontology draft resulted from an exchange of the [Chair of Automobile Engineering at TU Dresden](https://tu-dresden.de/bu/verkehr/iad/kft?set_language=en) with representatives of NFDI4Ing (Community Cluster 4.4, Archetype Golo, Base Services S3) and FID move in NFDI4Ing's Special Interest Group "Metadata and Ontologies". An essential part of that meeting was the presentation of the reseaerch data management approach at the Chair of Automobile Engineering, in particular its tooling, its metadata approach and its workflow.
Traffic observations are managed with ListDB, a solution combined of a SharePoint instance and a virtual machine for data servicing . An accompanying Codebook defines relevant metadata that should be provided for each road traffic observation. ListDB is currently used internally within TU Dresden, but is intentended to be hosted publicly until spring 2023.
Traffic observations are managed with ListDB, a solution combined of a SharePoint instance and a virtual machine for data servicing . An accompanying Codebook defines relevant metadata that should be provided for each road traffic observation. ListDB is currently used internally within TU Dresden, but is intentended to be hosted publicly until spring 2023.
The ontology draft is, in fact, based on the Codebook (v. 1.0.0.) and an attempt to make a machine-readable document out of it, applying standards from the Semantic Web Stack (RDF(S) and OWL). The draft is constantly being developed further in this context.
The ontology draft is, in fact, based on the Codebook (v. 1.0.0.) and an attempt to make a machine-readable document out of it, applying standards from the Semantic Web Stack (RDF(S) and OWL). The draft is constantly being developed further in this context.
Research data management with ListDB and the ontology draft has been the topic of a Workshop at NFDI4Ing 2021 Conference (see [References](README.md#References)).
## Project status
This project provides a draft.
## Roadmap
This project provides a draft.
## Wegweiser/Orientation
To help you find your way around this GitLab repository, here are a few words about its structure and contents. Each subdirectory contains its own README.md detailing the contents of the subdirectory.
- You are currently at the [README.md](README.md): Gives you information about the project and the contents of this repo - you will also find information about how to get into contact, about the usage of this project, and additional resources (slides, papers, services, etc.)
- [application_example](application_example): Contains an example metadata file for a traffic observation data set in different formalisations (textual/.txt, ontology-based rdf/xml/.owl, ontology-based JSON-LD/.json)
- [scripts](scripts): Contains scripts for different purposes (e.g. testing the ontology, creating its documentation)
- [shacl_shapes](shacl_shapes): Contains code for data validation that applies terms of the ontology according to W3C's [Shapes Constraints Language (SHACL)](https://www.w3.org/TR/shacl/)
- [visualizations](visualizations): Contains some visuals explaning the interplay of ontology classes and concepts and that are used on the ontologie's documentation.
- [widoco_sections](widoco_sections): Contains customised sections for the ontology documentation at [add link here]()
- [.gitlab-ci.yml](.gitlab-ci.yml): Defines a couple of tasks to be run by the GitLab CI/CD
- [20210511_ListDB_Codebook_v1.0.pdf](20210511_ListDB_Codebook_v1.0.pdf): The original Codebook of ListDB, defining categories for traffic observation metadata - this is the source of truth for ListDBOnto
- [CONTRIBUTING.md](CONTRIBUTING.md): Some hints on how you can get in touch with us and conribute to the project
- [ListDB-Onto.owl](ListDB-Onto.owl): This is the actual ontology, representing the categories from the [20210511_ListDB_Codebook_v1.0.pdf](20210511_ListDB_Codebook_v1.0.pdf) applying W3C standards like [Resource Description Framework (RDF)](https://www.w3.org/TR/rdf11-primer/), [Resource Description Framework Schema (RDFS)](https://www.w3.org/TR/rdf-schema/), and the [Web Ontology Language (OWL)](https://www.w3.org/TR/owl2-primer/)
## Roadmap/ Further development
- finalisation of ListDB Ontology draft and publication of GitLab repo
- integration of ListDB Ontology into NFDI4Ing Terminology Service
- integration into NFDI4Ing RDM Services and development of use cases
- initiate discussion about road traffic observation metadata with the community for higher interoperability of research data between research locations.
## Usage
For application examples see [application_example](application_example).
## Contributing
Contributions are possible as [issues](https://gitlab.hrz.tu-chemnitz.de/s4308286--tu-dresden.de/listdb/-/issues) or as pull requests. See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
## Working with the ontology
[ListDB-Onto.owl](ListDB-Onto.owl) is a text file serialized in RDF/XML. It can be opened and edited with regular text editors. A specialized tool for working with ontologies is [Protégé](https://protege.stanford.edu/) of Stanford University.
## Support
If you need support, please leave an [issue](https://gitlab.hrz.tu-chemnitz.de/s4308286--tu-dresden.de/listdb/-/issues).
## License
......@@ -36,22 +57,25 @@ If you need support, please leave an [issue](https://gitlab.hrz.tu-chemnitz.de/s
<a rel="license" href="http://creativecommons.org/licenses/by-nc/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc/4.0/80x15.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc/4.0/">Creative Commons Attribution-NonCommercial 4.0 International License</a>.
## Authors and acknowledgment
The ListDB Codebook is authored by [Maximilian Bäumler](https://orcid.org/0000-0003-4052-0572) and [Matthias Lehmann](https://orcid.org/0000-0002-6407-3028) at the [Chair of Automobile Engineering at TU Dresden](https://tu-dresden.de/bu/verkehr/iad/kft?set_language=en).
The ListDB Ontology has been drafted by [Susanne Arndt](https://orcid.org/0000-0002-1019-9151) at TIB - Leibniz Information Center for Science and Technology University Library.
# References
Albertoni, Ricardo et al. (2020): Data Catalog Vocabulary (DCAT) - Version 2. W3C Recommendation. URL: https://www.w3.org/TR/vocab-dcat-2/
## References
Albertoni, Ricardo et al. (2020): Data Catalog Vocabulary (DCAT) - Version 2. W3C Recommendation. URL: [https://www.w3.org/TR/vocab-dcat-2/](https://www.w3.org/TR/vocab-dcat-2/)
Arndt, Susanne; Bäumler, Maximilian; Roski, Stefanie; Fuchs, Matthias (2021): Strukturierte Metadaten in den Verkehrswissenschaften. In: Marco Berger, Jan Linxweiler & Stefanie Roski (eds): NFDI4Ing Conference 2021 - Collection of Abstracts. Zenodo. DOI: [https://doi.org/10.5281/zenodo.5702697](https://doi.org/10.5281/zenodo.5702697).
Arndt, Susanne; Bäumler, Maximilian; Roski, Stefanie; Fuchs, Matthias (2021): Strukturierte Metadaten in den Verkehrswissenschaften. In: Marco Berger, Jan Linxweiler & Stefanie Roski (eds): NFDI4Ing Conference 2021 - Collection of Abstracts. Zenodo. https://doi.org/10.5281/zenodo.5702697.
- Slide Set 1: https://cloudstore.zih.tu-dresden.de/index.php/s/FdsMH5JfxpGxCfo
- Slide Set 2: https://cloudstore.zih.tu-dresden.de/index.php/s/fajs8GPBoXQ5c23
- Slide Set 1: [https://cloudstore.zih.tu-dresden.de/index.php/s/FdsMH5JfxpGxCfo](https://cloudstore.zih.tu-dresden.de/index.php/s/FdsMH5JfxpGxCfo)
- Slide Set 2: [https://cloudstore.zih.tu-dresden.de/index.php/s/fajs8GPBoXQ5c23](https://cloudstore.zih.tu-dresden.de/index.php/s/fajs8GPBoXQ5c23)
Brickley, Dan (2009): WGS84 Geo Positioning: an RDF vocabulary. URI: (http://www.w3.org/2003/01/geo/wgs84_pos#).
Brickley, Dan (2009): WGS84 Geo Positioning: an RDF vocabulary. URI: [http://www.w3.org/2003/01/geo/wgs84_pos#](http://www.w3.org/2003/01/geo/wgs84_pos#).
DCMI Usage Board (2020): DCMI Metadata Terms. URI: (http://purl.org/dc/elements/1.1/), (http://purl.org/dc/terms/).
DCMI Usage Board (2020): DCMI Metadata Terms. URI: [http://purl.org/dc/elements/1.1/](http://purl.org/dc/elements/1.1/), [http://purl.org/dc/terms/](http://purl.org/dc/terms/).
Miles, Alistair; Bechhofer, Sean (2004): SKOS Vocabulary. URI: (http://www.w3.org/2004/02/skos/core#).
Miles, Alistair; Bechhofer, Sean (2004): SKOS Vocabulary. URI: [http://www.w3.org/2004/02/skos/core#](http://www.w3.org/2004/02/skos/core#).
Open Geospatial Consortium (2012): OGC GeoSPARQL – A Geographic Query Language for RDF Data. URI: (http://www.opengis.net/ont/geosparql#).
Open Geospatial Consortium (2012): OGC GeoSPARQL – A Geographic Query Language for RDF Data. URI: [http://www.opengis.net/ont/geosparql#](http://www.opengis.net/ont/geosparql#).
QUDT.org (2022): Quantities, Units, Dimensions and Types. URI: (http://qudt.org/schema/qudt/). DOI: (https://doi.org/10.25504/FAIRsharing.d3pqw7).
QUDT.org (2022): Quantities, Units, Dimensions and Types. URI: [http://qudt.org/schema/qudt/](http://qudt.org/schema/qudt/). DOI: [https://doi.org/10.25504/FAIRsharing.d3pqw7](https://doi.org/10.25504/FAIRsharing.d3pqw7).
# Application examples (WIP)
This directory contains an exemplary metadata description for a traffic observation data set. The three files are different serializations containing the same information.
## File 1: [application_example/20210512_1452_Fic_Hec_4W_d_1.txt](application_example/20210512_1452_Fic_Hec_4W_d_1.txt)
This text file is the original exemplary metadata file which demonstrates the structure of metadata files that are actually included in the ListDB data base.
## File 2: [application_example/20210512_1452_Fic_Hec_4W_d_1.owl](application_example/20210512_1452_Fic_Hec_4W_d_1.owl)
This file is an RDF/XML serialization of an RDF-based representation of the metadata information in File 1. It applies the terms of ListDBOnto and has been created manually.
## File 3: [application_example/20210512_1452_Fic_Hec_4W_d_1.json](application_example/20210512_1452_Fic_Hec_4W_d_1.json)
This file is a JSON-LD serialization of an RDF-based representation of the metadata information in File 1. It has been created with an open RDF-converter [1] from File 2.
## Resources
[1] Easy RDF Converter. URL: [https://www.easyrdf.org/converter](https://www.easyrdf.org/converter).
# Scripts
This directory contains scripts for different purposes.
## [scripts/tests](scripts/tests)
Contains a python script applying [rdflib](https://rdflib.readthedocs.io/en/stable/#) to test whether ListDB can be parsed as a graph. This test is run each time a change on the ontology is commited to a merge request. Alternatively, the test can be triggered manually in the CI/CD menu of the repository. It helps to ensure that the ontology on the main and develop branch are in working order at all times.
## [scripts/widoco](scripts/widoco)
Contains scripts to customise sections of the [documentation of ListDBOnto](). This documentation is auto-generated from the ontology file with [Widoco](https://github.com/dgarijo/Widoco).
\ No newline at end of file
# Data validation with the Shapes Constraints Language
## A general example
With the [Shapes Constraints Language (SHACL)](https://www.w3.org/TR/shacl/) it is possible to define a set of conditions against which an RDF graph can be validated for well-formedness.
This set of conditions is itself modelled as an RDF graph. These so-called "shapes graphs" can re-use ontology terms and other RDF data.
......@@ -88,3 +90,26 @@ Evaluating these data against the shapes graph, would result in the following vi
]
] .
```
## Data validation for traffic observation data sets
The shapes defined here can be used to validate metadata files applying terms from ListDBOnto. To validate the complete metadata file the shape [shacl_shapes/metadata_file_shape.ttl](shacl_shapes/metadata_file_shape.ttl) can be used.
### Validate with Protégé
1. Get [Minimal SHACL Editor PlugIn for Protégé](https://github.com/fekaputra/shacl-plugin)
2. Open RDF-based metadata file from [application_example](application_example), e.g. []() which has intentional violations
3. Open [shacl_shapes/metadata_file_shape.ttl](shacl_shapes/metadata_file_shape.ttl) in Minimal SHACL Editor Tab in Protégé
4. Run validate.
### Validate online
There are a couple of online SHACL validators, e.g.
- [SHACL Play!](https://shacl-play.sparna.fr/play/validate)
- [SHACL Playground](https://shacl.org/playground/)
- [SHACL Playground by Zazuko](https://shacl-playground.zazuko.com/)
These either allow you to paste your code or to use URIs to fetch the data as well as the shape.
At SHACL Play!, for instance, you can just point to the files on this repo and get the validation report in no time.
# Visualizations
This directory contains some graphics for the ontology's documentation. They demonstrate the interplay of ontology classes and properties for traffic observation metadata files.
This directory contains text snippets that will be used in a documentation generated from the ontology by Widoco.
This directory contains text snippets that will be used in a documentation generated from the ontology by Widoco. It also contains the configuration data for Widoco.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment