Commit 5108d910 authored by Timm Schoening's avatar Timm Schoening
Browse files

Update README.md

parent 59e71c61
......@@ -34,20 +34,30 @@ On German research vessels, the "scientists folder" on the network or the new "M
```
## Provenance documentation:
Provenance documentation of (automated) SOP steps is required to enable reusability of data and validity checks. Provenance information needs to document the entities, agents and activities and should facilitate reproducibility but mainly document execution steps rather than enable the fully automated re-execution which would require automated setup of the software environment (through Docker etc.). Provenance of individual SOP steps should be recorded in a machine-readable fashion (i.e. a **yaml** or json file) like so:
Provenance documentation of (automated) SOP steps is required to enable reusability of data and validity checks. Provenance information needs to document the agent, entities and activities and should facilitate reproducibility but mainly document execution steps rather than enable the fully-automated re-execution which would further require the automated setup of the software environment (e.g. through Docker). Provenance of individual SOP steps should be recorded in a machine-readable fashion (i.e. a **yaml** file) like so:
```
executable:
path: <executable name>
hash: <md5 hash of executable binary>
time: <utc time of execution, milliseconds since epoch>
version: <version string of executable>
parameter:
- name: <param-x_name>
value: <param-x_value>
[hash: md5 hash of file at <param-x_value> (optional, only for files)]
- name: <param-y_name>
value: <param-y_value>
provenance:
- action:
executable:
name: <executable name>
version: <version string of executable>
parameter:
- name: <param-x_name>
value: <param-x_value>
[hash: <md5 hash of file at <param-x_value> (optional, only for files)>]
- name: <param-y_name>
value: <param-y_value>
hash: null
time: <time of execution: in utc, human-readable, with milliseconds (%Y%m%d %H:%M:%S.%f%z)>
- action:
executable:
...
parameter:
...
hash: <sha256 hash of previous provenance file>
time: ...
```
In case an additional processing step applied to a entity, the additional provenance information shall be appended to the provenance file of the entities' creation. Together with the SHA256 hash of the previous provenance file, a blockchain-like behaviour is enabled.
# Standard operating procedures (SOPs)
Currently (March 2021), the few available SOPs are just bullet-point lists but detailed versions and jupyter notebooks to execute the curation steps are in preparation.
......
Markdown is supported
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