Skip to content

Commit 2785f04

Browse files
committed
doc: minimal provenance documentation
1 parent f329d5e commit 2785f04

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

doc/devel/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ conventions documented in the `NIPY Developers Guide
1717
writing_custom_interfaces
1818
gitwash/index
1919
architecture
20+
provenance
2021

2122

2223
.. include:: ../links_names.txt

doc/devel/provenance.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
================
2+
W3C PROV support
3+
================
4+
5+
Overview
6+
--------
7+
8+
We're using the the `W3C PROV data model <http://www.w3.org/TR/prov-dm/`_ to
9+
capture and represent provenance in Nipype.
10+
11+
For an overview see:
12+
13+
`PROV-DM overview <http://slideviewer.herokuapp.com/url/raw.github.com/ni-/notebooks/master/NIDMIntro.ipynb>`_
14+
15+
Each interface writes out a provenance.json (currently prov-json) or
16+
provenance.rdf (if rdflib is available) file. The workflow engine can also
17+
write out a provenance of the workflow if instructed.
18+
19+
This is very much an experimental feature as we continue to refine how exactly
20+
the provenance should be stored and how such information can be used for
21+
reporting or reconstituting workflows.

0 commit comments

Comments
 (0)