https://github.com/dlr-sc/bacardi-prov-model
A reference implementation for the BACARDI PROV data model.
https://github.com/dlr-sc/bacardi-prov-model
prov-generation provenance provenance-data provenance-model w3c-prov
Last synced: 4 months ago
JSON representation
A reference implementation for the BACARDI PROV data model.
- Host: GitHub
- URL: https://github.com/dlr-sc/bacardi-prov-model
- Owner: DLR-SC
- License: other
- Created: 2023-01-10T10:26:49.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-20T14:21:49.000Z (over 2 years ago)
- Last Synced: 2024-12-31T05:41:59.463Z (6 months ago)
- Topics: prov-generation, provenance, provenance-data, provenance-model, w3c-prov
- Language: Python
- Homepage:
- Size: 145 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Citation: CITATION.cff
Awesome Lists containing this project
README
Welcome to the BACARDI PROV Data Model! 👋
> A reference implementation for the BACARDI PROV Data Model.
---
## ️🏗️ ️Installation
Clone the project and install using `pip` from the project root directory:
```bash
pip install .
```
## ⚡ Getting started
The BACARDI PROV data model has been designed according to [W3C PROV](https://www.w3.org/TR/prov-overview/) specification.
The reference implementation uses the Python library [prov](https://github.com/trungdong/prov).
### Task Model
Currently, only the `task` model is defined and documented in [docs/task.md](docs/task.md).
It specifies how provenance of a task in BACARDI must be recorded according to the W3C PROV standard.
The reference implementation can be found in the [task](bacardi_prov_model/task.py) module.
## 🚀 Execute Examples
Once installed, the example scripts can be executed on the command line.
All scripts create a directory `example-output` in the current working directory and generate their content into it.
You can execute the scripts as follows:
```sh
# Generates provenance bundle using the extended task model
task-bundle
# Generates provenance bundle using the simplified task model
simple-task-bundle
# Generates two provenance bundles using the simplified task model
multi-task-bundle
```
## ✨ How to cite
If you use the BACARDI PROV data model in a scientific publication, we would appreciate citing the following paper:
* M. Stoffers, M. Meinel, B. Hofmann and A. Schreiber, "Integrating Provenance-Awareness into the Space Debris Processing System BACARDI," 2022 IEEE Aerospace Conference (AERO), 2022, pp. 1-12, doi: 10.1109/AERO53065.2022.9843783.
Bibtex entry:
```BibTeX
@INPROCEEDINGS{9843783,
author={Stoffers, Martin and Meinel, Michael and Hofmann, Benjamin and Schreiber, Andreas},
booktitle={2022 IEEE Aerospace Conference (AERO)},
title={Integrating Provenance-Awareness into the Space Debris Processing System BACARDI},
year={2022},
volume={},
number={},
pages={1-12},
doi={10.1109/AERO53065.2022.9843783}
}
```
You can also cite specific releases published on Zenodo: [](https://zenodo.org/badge/latestdoi/587256493)
## ✏️ References
**Papers that refer to the `BACARDI PROV Data Model`**:
* Stoffers, Martin and Meinel, Michael and Hofmann, Benjamin and Fiedler, Hauke (2022) A use case study on provenance-based data assessments for mission critical software systems. In: 73rd International Astronautical Congress (IAC 2022). 73rd International Astronautical Congress (IAC 2022), 18.-22. Sep. 2022, Paris, France. (In Press)
## 📝 License
Please see the file [LICENSE.md](LICENSE.md) for further information about how the content is licensed.