Commit 1a725353 authored by Susanne Arndt's avatar Susanne Arndt
Browse files

Merge branch '2-update-main-readme-md' into 'main'

Resolve "Update main README.md"

Closes #2

See merge request !4
parents 42a6b11f f615ad67
Pipeline #60574 failed with stage
# ListDB
# ListDB Ontology
This is an ontology draft for the description of metadata of traffic observations, in particular video recordings of road traffic.
The draft resulted from an exchange of the Chair of Automobile Engineering at TU Dresden 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.
## Getting started
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.
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
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).
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
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)).
## Add your files
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
```
cd existing_repo
git remote add origin https://gitlab.hrz.tu-chemnitz.de/s4308286--tu-dresden.de/listdb.git
git branch -M main
git push -uf origin main
```
## Integrate with your tools
- [ ] [Set up project integrations](https://gitlab.hrz.tu-chemnitz.de/s4308286--tu-dresden.de/listdb/-/settings/integrations)
## Collaborate with your team
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
## Test and Deploy
Use the built-in continuous integration in GitLab.
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
***
# Editing this README
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
## Suggestions for a good README
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
## Project status
This project provides a draft.
## Name
Choose a self-explaining name for your project.
## Roadmap
- 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.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Usage
[https://gitlab.hrz.tu-chemnitz.de/s4308286--tu-dresden.de/listdb/-/issues/8](https://gitlab.hrz.tu-chemnitz.de/s4308286--tu-dresden.de/listdb/-/issues/8)
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Contributing
Contributions are possible as [issues](https://gitlab.hrz.tu-chemnitz.de/s4308286--tu-dresden.de/listdb/-/issues) or as pull requests.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## 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.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
## Support
If you need support, please leave an [issue](https://gitlab.hrz.tu-chemnitz.de/s4308286--tu-dresden.de/listdb/-/issues).
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## License
[https://gitlab.hrz.tu-chemnitz.de/s4308286--tu-dresden.de/listdb/-/issues/6](https://gitlab.hrz.tu-chemnitz.de/s4308286--tu-dresden.de/listdb/-/issues/6)
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Authors and acknowledgment
[https://gitlab.hrz.tu-chemnitz.de/s4308286--tu-dresden.de/listdb/-/issues/7](https://gitlab.hrz.tu-chemnitz.de/s4308286--tu-dresden.de/listdb/-/issues/7)
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
# References
Albertoni, Ricardo et al. (2020): Data Catalog Vocabulary (DCAT) - Version 2. W3C Recommendation. URL: https://www.w3.org/TR/vocab-dcat-2/
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
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
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
Brickley, Dan (2009): WGS84 Geo Positioning: an RDF vocabulary. URI: (http://www.w3.org/2003/01/geo/wgs84_pos#).
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
DCMI Usage Board (2020): DCMI Metadata Terms. URI: (http://purl.org/dc/elements/1.1/), (http://purl.org/dc/terms/).
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
Miles, Alistair; Bechhofer, Sean (2004): SKOS Vocabulary. URI: (http://www.w3.org/2004/02/skos/core#).
## License
For open source projects, say how it is licensed.
Open Geospatial Consortium (2012): OGC GeoSPARQL – A Geographic Query Language for RDF Data. URI: (http://www.opengis.net/ont/geosparql#).
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
QUDT.org (2022): Quantities, Units, Dimensions and Types. URI: (http://qudt.org/schema/qudt/). DOI: (https://doi.org/10.25504/FAIRsharing.d3pqw7).
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