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 app Windows or Apple Silicon macOS Download
Python package Windows, macOS, or Linux with Python 3.11–3.13 python -m pip install fp-tools-bio
Container Complete reproducible environment docker run --rm -p 8891:8891 ghcr.io/oncologylab/fp-tools:latest

Python package example:

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

External genomics programs are downloaded into a private, versioned cache on first use. They do not need to be installed separately. Docker remains an optional reproducible backend.

Bulk ATAC-seq

bulk-footprinting can run from FASTQ files or public run accessions through the final interactive comparison report.

bulk-footprinting \
  --reads-table reads.tsv \
  --comparison-table comparisons.tsv \
  --genome hg38 \
  --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, fp-tools-runtime
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.0rc5.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.0rc5-cp313-cp313-win_amd64.whl (1.7 MB view details)

Uploaded CPython 3.13Windows x86-64

fp_tools_bio-0.2.0rc5-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.0rc5-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.0rc5-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.0rc5-cp313-cp313-macosx_11_0_arm64.whl (1.7 MB view details)

Uploaded CPython 3.13macOS 11.0+ ARM64

fp_tools_bio-0.2.0rc5-cp312-cp312-win_amd64.whl (1.7 MB view details)

Uploaded CPython 3.12Windows x86-64

fp_tools_bio-0.2.0rc5-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.0rc5-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.0rc5-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.0rc5-cp312-cp312-macosx_11_0_arm64.whl (1.7 MB view details)

Uploaded CPython 3.12macOS 11.0+ ARM64

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

Uploaded CPython 3.11Windows x86-64

fp_tools_bio-0.2.0rc5-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.0rc5-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.0rc5-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.0rc5-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.0rc5.tar.gz.

File metadata

  • Download URL: fp_tools_bio-0.2.0rc5.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.0rc5.tar.gz
Algorithm Hash digest
SHA256 889df944d086ea58056bf06f9d793652b955cac8af7ce0f4bb1001b9b7d6af8d
MD5 5eaf9b0e8f6839cfe16d4f7ec6cb0dcd
BLAKE2b-256 3bb057c02f0d58bf97bd0b307781d0d191e2adb0ace8b6bcb620503f1ddabac9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc5-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 0620f335009df48ff8b8daac6acf7f5edd1c13f206e0b04d66ac28deb6e627ec
MD5 49e3755c77125ece804ade64e62c9b7b
BLAKE2b-256 b391e5b736587aa6e81664438372aec11e334ed95c854776165bfa0f1e997085

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc5-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.0rc5-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 0d0db5f09fd0ef98bf4a4d37279cb74057f441609dd21e24bdc45fd99a487ced
MD5 c9cb6ddcc68b4a653dd2a50cd118cc90
BLAKE2b-256 af31e968f4fb9293f3b3fca7cbf6843b47165581de3609e427e4d00c85b9851a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc5-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 9ee3b9f339c5b7a5e70f4c3642dfef4473fc7d01d153317eaef46a72ecb76515
MD5 0212ab8a58243e9f8e7ac2b052d5f009
BLAKE2b-256 c1593858565a8aa325d6d97057811281ae590fa7b9d94f8f20e5cc81fa52e2c2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc5-cp313-cp313-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 443671c27e7c136f336a7dca464b11fa7089af125f00290d4a7726b4b2b3733b
MD5 34acf6527796356c5420a9fa3c0eaa28
BLAKE2b-256 a724a88e65287e3c799930d518c1f586189e06cea095b3310e1212fc645939e8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc5-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 b49b9c8ce9f3f2e4674b229ee85a04561d392a1955f7f14c14f7f4a6fcde8e28
MD5 8acda8f50a9c255f8736113b30480087
BLAKE2b-256 e477f634e19010fdbb51ba578def4f1469d648cf549daa4bda1a58e4cc2625ba

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc5-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 0bac6b3b3bb05270d6b2b194fa96ff68750ae1dcb35bb060899943efddcac7fb
MD5 8b58ab36e1ef2f780d809e073f15f447
BLAKE2b-256 8dc4a74562cd7c20dead3f690ab60d982ae5149bf51e06c85db3d71a7f4772c4

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc5-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.0rc5-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 3906abff3e9465495680bcf7120ba39769c503f541e6442eea4d5f668b2bb891
MD5 d4e56f3f8c9b9273464ed1767648a62c
BLAKE2b-256 71d96288e6bc84c4655a17f54076c84d2a0c0b3359bdf6a4c2d2795314524e76

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc5-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 6905451a7f16916fd336b9de9b09902a889929a4b6f8f46589bf9e992e58f0ad
MD5 a4d68ec52e95716ab154efeb292a9a5e
BLAKE2b-256 c3ec0685ec0edafb932a1dd53ad4e1b4dc797ddb382eda0dfc0e0aab5df8c53d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc5-cp312-cp312-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 4729c30890d681b97f17e71e5d5b27aa93291d315ff5f2a28f2315a3ad332aa1
MD5 b499c530725537281f535652e6a84d37
BLAKE2b-256 33c47ad51f9364fb1c157ef0bd0bc29c457f8c83c66c17224bd640b78238cf44

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc5-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 f8255a0a4f7cc79243d475c2e3e994add06bd70a84825b3f79dc5ce9023591e6
MD5 8d19ccae12f5f52b58bc141da04e1bc7
BLAKE2b-256 0e3fbeb9f3f7a3bf83d92b028e6f04d77ebb1f1092f1c749615ed4e69b322d53

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc5-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 4ec64c8878285f87acbbee96a6255d5a3bc3238db906c8432721ddd54a795882
MD5 6139fb49d54824dedf4f5846778d49cb
BLAKE2b-256 d5a15e6a6af572d1428b431f5983c7027da1d8d0431eea0fd0514b196a378197

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc5-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.0rc5-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 8eb52d536df0112a7b0a2ff70ed2483590dab3f729f59463a17ef88390bb7d5a
MD5 4e14c7d4e628bd81d5bd7713988c6b85
BLAKE2b-256 51abf54ea60a37b6af5c0fe22ccc7a06af7239fa81f69fe3a5bd5a4be8f3ad2f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc5-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 30f7ccfcb0090eed5d4fb0b508076d0fc931deaa229f21bd3b397fd1c41a1ac2
MD5 549f6d0936215ec25212db818e203d62
BLAKE2b-256 5427ad45bee559ccfcf9e63cff4d180773e92703496a19486ecc3a3639b719bf

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc5-cp311-cp311-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 0de4ed90f724c483edd205bcae32732937a9a93eae118981712858f3793b717c
MD5 dd7a7b7ba4ffb217e3c8e07bee3228a5
BLAKE2b-256 63ae20be7b98e5ba5f1c2bf64fe0dcafa33374b317e2a24d546eb0c6649eb954

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc5-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 64e17aafaa0b0d49d7c938e749364f9b8529c34b140b6d9f9a5af4bfe5c1ec7e
MD5 0b1d95d5d54775b6aebfd5e000bda3b5
BLAKE2b-256 9a83dae8ade907f6f8eb7858b39580299db35b5e319cbf060912df72938ccea6

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.2.0rc5 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