Commit bbf6bf42 authored by Timm Schoening's avatar Timm Schoening
Browse files

Update provenance-documentation.md

parent 013daf20
......@@ -2,26 +2,24 @@
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:
```
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>
log: all the logging information from the executable
- 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>
log: all the logging information from the executable
hash: null
time: <time of execution: in utc, human-readable, with milliseconds (%Y%m%d %H:%M:%S.%f)>
- action:
executable:
...
parameter:
...
log:
...
- executable:
...
parameter:
...
log:
...
hash: <md5 hash of previous provenance file>
time: ...
```
......
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