Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

fp-tools — regulatory footprinting

PyPI CI License: MIT

Documentation · Output demo with ENCODE cancer cell lines · GUI demo · PyPI

fp-tools is a command-first toolkit for footprinting Tn5-based chromatin profiling data, including ATAC-seq, CUT&Tag, and related assays. It provides bias correction, motif analysis, replicate-aware comparisons, and single-cell footprint signatures. The GUI and YAML runner call the same commands.

Install

Choose one route:

Route Best for Start
Desktop executable GUI without Python Download for Windows, macOS, or Linux
Complete container GUI plus raw-read and motif-discovery programs docker run --rm -p 8891:8891 ghcr.io/oncologylab/fp-tools:latest
Python package Direct commands in an existing Python environment python -m pip install fp-tools-bio

Python package example:

python -m pip install --pre fp-tools-bio
fp-tools-gui

Python 3.11–3.13 is supported on Windows, macOS, and Linux. The container is the complete environment for raw FASTQ processing and external MEME tools.

Bulk ATAC-seq

bulk-footprinting runs the complete analysis from aligned BAM and peak files. FASTQ preparation remains available separately through prepare-atac.

bulk-footprinting \
  --sample-table samples.tsv \
  --comparison-table comparisons.tsv \
  --genome hg38.fa.gz \
  --blacklist hg38.blacklist.bed \
  --outdir project \
  --cores 8

The wrapper runs atac-correct, call-footprints, match-motifs, diff-footprints, and review-multi-comparisons. Each command can also be run directly. diff-footprints --comparison-axis regions compares matched genomic region sets within one sample or across biological replicates.

Single-cell ATAC-seq

sc-footprinting groups fragments, runs pseudobulk footprinting, and produces per-cell KNN footprint-signature heatmaps and UMAPs.

sc-footprinting \
  --fragments fragments.tsv.gz \
  --annotations cell_annotations.tsv \
  --h5ad embedding.h5ad \
  --group-by cell_type \
  --genome-sizes hg38.chrom.sizes \
  --genome hg38.fa.gz \
  --peaks merged_peaks.bed \
  --outdir project/single_cell

Main commands

Area Commands
Core analysis prepare-atac, atac-correct, call-footprints, match-motifs, diff-footprints, normalize-bigwig
Workflows bulk-footprinting, sc-footprinting, run-yaml-workflow, fp-tools-gui
Reports plot-aggregate, review-multi-comparisons
De novo motifs discover-motifs, summarize-motifs
Single-cell utilities pseudobulk-fragments, find-signature-fp

Use <command> --help for complete options. Practical examples and the API reference are available in the documentation.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fp_tools_bio-0.2.0rc4.tar.gz (1.5 MB view details)

Uploaded Source

Built Distributions

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

fp_tools_bio-0.2.0rc4-cp313-cp313-win_amd64.whl (1.6 MB view details)

Uploaded CPython 3.13Windows x86-64

fp_tools_bio-0.2.0rc4-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl (3.0 MB view details)

Uploaded CPython 3.13manylinux: glibc 2.17+ x86-64manylinux: glibc 2.28+ x86-64

fp_tools_bio-0.2.0rc4-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl (2.9 MB view details)

Uploaded CPython 3.13manylinux: glibc 2.17+ ARM64manylinux: glibc 2.28+ ARM64

fp_tools_bio-0.2.0rc4-cp313-cp313-macosx_11_0_x86_64.whl (1.7 MB view details)

Uploaded CPython 3.13macOS 11.0+ x86-64

fp_tools_bio-0.2.0rc4-cp313-cp313-macosx_11_0_arm64.whl (1.7 MB view details)

Uploaded CPython 3.13macOS 11.0+ ARM64

fp_tools_bio-0.2.0rc4-cp312-cp312-win_amd64.whl (1.6 MB view details)

Uploaded CPython 3.12Windows x86-64

fp_tools_bio-0.2.0rc4-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl (3.0 MB view details)

Uploaded CPython 3.12manylinux: glibc 2.17+ x86-64manylinux: glibc 2.28+ x86-64

fp_tools_bio-0.2.0rc4-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl (3.0 MB view details)

Uploaded CPython 3.12manylinux: glibc 2.17+ ARM64manylinux: glibc 2.28+ ARM64

fp_tools_bio-0.2.0rc4-cp312-cp312-macosx_11_0_x86_64.whl (1.7 MB view details)

Uploaded CPython 3.12macOS 11.0+ x86-64

fp_tools_bio-0.2.0rc4-cp312-cp312-macosx_11_0_arm64.whl (1.7 MB view details)

Uploaded CPython 3.12macOS 11.0+ ARM64

fp_tools_bio-0.2.0rc4-cp311-cp311-win_amd64.whl (1.7 MB view details)

Uploaded CPython 3.11Windows x86-64

fp_tools_bio-0.2.0rc4-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl (3.0 MB view details)

Uploaded CPython 3.11manylinux: glibc 2.17+ x86-64manylinux: glibc 2.28+ x86-64

fp_tools_bio-0.2.0rc4-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl (3.0 MB view details)

Uploaded CPython 3.11manylinux: glibc 2.17+ ARM64manylinux: glibc 2.28+ ARM64

fp_tools_bio-0.2.0rc4-cp311-cp311-macosx_11_0_x86_64.whl (1.7 MB view details)

Uploaded CPython 3.11macOS 11.0+ x86-64

fp_tools_bio-0.2.0rc4-cp311-cp311-macosx_11_0_arm64.whl (1.7 MB view details)

Uploaded CPython 3.11macOS 11.0+ ARM64

File details

Details for the file fp_tools_bio-0.2.0rc4.tar.gz.

File metadata

  • Download URL: fp_tools_bio-0.2.0rc4.tar.gz
  • Upload date:
  • Size: 1.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.12.13

File hashes

Hashes for fp_tools_bio-0.2.0rc4.tar.gz
Algorithm Hash digest
SHA256 59f79224a9d713dc9deb773429da3ab36a7506bdf9794d0e081f5d6bed4dab98
MD5 397457daf3213874b27e1d1a66e82e34
BLAKE2b-256 d0b80aee6f682bac9acbda48980f6ead1991a12647c2b109e3440e2bc6c35ddc

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc4-cp313-cp313-win_amd64.whl.

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc4-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 b56554fcf8932f6886bd2a15953de5f36955ca6a67045fc1c0cb564199c59265
MD5 06d356abc9b7a2a99c900bab1753b9be
BLAKE2b-256 1115e8fd853fe3dea4bbd474215ad101f141ba24ddb60bc50813c0fc6d05347a

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc4-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc4-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 2296c3ecdc3c66d6b06ffe5c206ee96b79adb9aa517e3b3df5a12b566869afb4
MD5 bfb97db6cd4a13d7c1c96a4f82396c36
BLAKE2b-256 1df277a477e2fb92a3fceae69a21ae610090de396326b6b071fa4263ae8171d3

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc4-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc4-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 77228fae65b611d0c8fe9d7edd3c78da8d7e720b51779e1a6b584d3367c09d76
MD5 62e0a3ea3ffe47d55c2b6e07a57a577f
BLAKE2b-256 7138bbc771d6daff24a6b1e2113f30638e89228f5ef5c1c3a782bbecdaa2edc0

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc4-cp313-cp313-macosx_11_0_x86_64.whl.

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc4-cp313-cp313-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 52dd25d062ffb16d4769a884372e856b8b502016204c1f75514ce334668279cf
MD5 f1fc1ed8f8a05249404912c42b98bce9
BLAKE2b-256 089aa503ada61b268fe6f132780e8adc27be13ea50f0710e09045eb18d9fef55

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc4-cp313-cp313-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc4-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 28984768d4b5f65f3ddfd670bf87daa2aa5a5570627340ad25c5186c8ad2990e
MD5 60d15e653f350865f4adb70d0a96d4d3
BLAKE2b-256 793df8bd6775e2a9dc1b38b1e1cc347ccadc3e6d2fdcb65a16bf2fd6c0cb5918

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc4-cp312-cp312-win_amd64.whl.

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc4-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 82aee2a9590bf26803dfe98eb41eff81778f0566ce296158041c4a41873d966f
MD5 bdb176d3cb14466cb69e9c285f79b373
BLAKE2b-256 486f63e09bdc89d5d33362efe26b2504068ebba96e2a2b3c3eb4d1ed9c1ec77a

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc4-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc4-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 d31bd84b2c86e5fa8181a2a44773fada5eddf9eba6cbea9ad3e47c394ed461f5
MD5 1b2549e2e8fdd8259517c7bb5f3c1df9
BLAKE2b-256 0c04310414f0994c880b0be49c4a67e91c63f48bff9a995eac2f8737a5dcce1e

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc4-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc4-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 eb8f0ba0fed7ce08701df49af058f8ce6b9894cf1d0c381010d2e26dc6d3d2c6
MD5 c577198c242154217ebe3ffc33e6e811
BLAKE2b-256 17b59e04f2012b7ac53c0371d3c1de18f91d6399be849829e66c81eb8e305b23

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc4-cp312-cp312-macosx_11_0_x86_64.whl.

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc4-cp312-cp312-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 3eb22274fbbb6670e0332dc060d39b59fcf0714fa341ccd7130c4e8f28bdc6e8
MD5 6d25160ae992a80e5d4e3c881bd7b363
BLAKE2b-256 ee3960989cc5df6fe0c1f181fcee07d82e6c91496293f99d5659d3eabe20d304

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc4-cp312-cp312-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc4-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 d7d5e7cc99fd23839dde53da810f87ea3a79a8fa83ecd5640a7956eaf0efb1b5
MD5 03d3d096df6e89da5a2e444bbdcfb56e
BLAKE2b-256 13fea321041da9842788ba898a77f83f29d5cfb870d8f31b44b755657e251d9c

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc4-cp311-cp311-win_amd64.whl.

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc4-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 b7d9b235049cd7cdcc578b07d0608dd9b7edeaf9676967423ff36c1f512dcf57
MD5 ec48e47ef442c394874b5e21bc20bff7
BLAKE2b-256 3e34dbb4c10170103ead54e63fd280963b331ad0ee83f3549bf31cff98773b6b

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc4-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc4-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 216ac07ec793d1aededd4f3ab6ed6f5abea2544ed539f05f07eb36b7d26ff820
MD5 606e2ff0782850858ed4986805598f91
BLAKE2b-256 0ce40c3b2873e60422073591c6f5280a670123ca922cf633a5d7d897cba5ed3c

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc4-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc4-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 7610df01ea54aea3df07cae65b02c454853ff5d5397462fa6e0d7e2fa8ec4084
MD5 02b5d39582ac030ee6a83eb287847c95
BLAKE2b-256 70ae2941ab9f896425969790f3f19a5a60d9b489179c2a4472fc2e1e8dc59283

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc4-cp311-cp311-macosx_11_0_x86_64.whl.

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc4-cp311-cp311-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 34ca5c0f0cc58c2f4859216d0f3a1cf01985857a566685cdc85ac5b89ef27b1c
MD5 1771412fb30971c5de8f716844e1d622
BLAKE2b-256 c67a7ec8c67f3364bc176375f41186fe15f097b6445d71d273c8327dc37de6b3

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc4-cp311-cp311-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc4-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 308036845749e62d1b2f61881724dd19a44f7adf02294f63e70c14c13f066f36
MD5 47ba5a2dcb64e155f3422b238d6893eb
BLAKE2b-256 dd194b02e0bb58da9da438928afbda12a3c5a62f94477d609421dd895360b102

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.2.0rc4 This release

16 files

0.1.18

2 files

0.1.17

2 files

0.1.16

2 files

0.1.15

2 files

0.1.14

2 files

0.1.13

2 files

0.1.12

2 files

0.1.11

2 files

0.1.10

2 files

0.1.9

1 file

0.1.8

1 file

0.1.7

1 file

0.1.6

1 file

0.1.5

1 file

0.1.4

1 file

Supported by

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