Skip to main content

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-prov plugin (configured automatically by sfprov init)

Project details


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.0.tar.gz (75.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sfprov-0.1.0-py3-none-any.whl (83.0 kB view details)

Uploaded Python 3

File details

Details for the file sfprov-0.1.0.tar.gz.

File metadata

  • Download URL: sfprov-0.1.0.tar.gz
  • Upload date:
  • Size: 75.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.15

File hashes

Hashes for sfprov-0.1.0.tar.gz
Algorithm Hash digest
SHA256 edb6647c663ca18c510fb2f68114c506f20627af2a85c72f55feeebdc5fc8f2f
MD5 9fbb672518353ad59a14d38fb4a606f0
BLAKE2b-256 768c9acc5dbc568ae40cbda69b03d93e8b2fb47dea5992f1e744f4ff2fa3c5cd

See more details on using hashes here.

File details

Details for the file sfprov-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: sfprov-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 83.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.15

File hashes

Hashes for sfprov-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b9af6d2e452805cd310dcd0e8a42a442c1a512493a7774f0180e3f2b4c227bd0
MD5 c7b84b55d4df23c4bce4e3f00886306e
BLAKE2b-256 51436e3daaa2c5e6729ccb6680c4195f1fac90ebf9489d66ef2846f7ef79d700

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page