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.2.tar.gz (100.2 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.2-py3-none-any.whl (95.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sfprov-0.1.2.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

Hashes for sfprov-0.1.2.tar.gz
Algorithm Hash digest
SHA256 2160ae61972641ac8e8979d1ee3553b5b6116fcf11a2bed15c991101ba39405e
MD5 14672606c00dea99907c06b862211367
BLAKE2b-256 a9b1c063b4e88e7d41eebf4b5327fdccf0c5a40fdcfd153880a21c385ef63963

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sfprov-0.1.2-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

Hashes for sfprov-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3d65456988b97da7659906abfffdb951f3b912c91d4fc4f117a8fd584a46b108
MD5 d5a3fce886f75988d3a32aedfab9d565
BLAKE2b-256 882ad718d52e532e482a70aa2752b667fb817a53e98270f3461c03d36a3e583b

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