Extract and store workflow provenance from RO-Crate and Nextflow DAG files.
Project description
sfprov — Workflow Provenance Parser
Extract, store, and query provenance from Nextflow pipelines into Neo4j.
Install
pip install sfprov # core
pip install sfprov[opensearch] # + OpenSearch indexing
pip install sfprov[extractors] # + file feature extraction
pip install sfprov[all] # everything
System dependencies (must be on PATH):
| Format | Tool |
|---|---|
| SAM / BAM / CRAM | samtools |
| VCF / BCF | bcftools |
Quick Start
# 1. Initialise (starts Neo4j, writes nextflow.config)
sfprov init
# 2. Run your Nextflow pipeline as usual
nextflow run main.nf
# 3. Ingest provenance
sfprov ingest --ro-crate ./results/provenance/ro-crate-metadata.json \
--lineage ./work
CLI
| Command | Description |
|---|---|
sfprov init |
Bootstrap services and configure Nextflow |
sfprov ingest |
Parse and load provenance into Neo4j |
sfprov parse |
Parse only (no write) |
sfprov status |
Check service health |
sfprov query |
Run canned graph queries |
Requirements
- Python ≥ 3.10
- Docker + Compose V2
- Nextflow ≥ 23 with
nf-provplugin (configured automatically bysfprov init)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
sfprov-0.1.1.tar.gz
(100.2 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
sfprov-0.1.1-py3-none-any.whl
(95.6 kB
view details)
File details
Details for the file sfprov-0.1.1.tar.gz.
File metadata
- Download URL: sfprov-0.1.1.tar.gz
- Upload date:
- Size: 100.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c5a6f7d67890e1dd734f0ecd6145e2de5446db4ff213f77092b266476de6abc2
|
|
| MD5 |
7ab84179b09697d0617528c9cb5781e5
|
|
| BLAKE2b-256 |
8e352c7352c9d6b5d2a6867dd8beca880c9e055ec745df3d2431f0eee9e74ca7
|
File details
Details for the file sfprov-0.1.1-py3-none-any.whl.
File metadata
- Download URL: sfprov-0.1.1-py3-none-any.whl
- Upload date:
- Size: 95.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
91e85d190489306675da67fc201f422bae4c06b2100a4c7658685b2ef6a6d4da
|
|
| MD5 |
f7e26e8c2528095059e63b7c846df33d
|
|
| BLAKE2b-256 |
8e2c33ff81dc28ea207faad1a62bdbdd5bc1b00237d7eaf42f2470f3f0a0adff
|