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

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

Python 3.11–3.13 is supported on Windows, macOS, and Linux. Core analysis and the GUI install from wheels; raw FASTQ preprocessing uses standard external bioinformatics tools (WSL on Windows).

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.0rc2.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.0rc2-cp313-cp313-win_amd64.whl (1.6 MB view details)

Uploaded CPython 3.13Windows x86-64

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

Uploaded CPython 3.13macOS 11.0+ ARM64

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

Uploaded CPython 3.12Windows x86-64

fp_tools_bio-0.2.0rc2-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.0rc2-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl (2.9 MB view details)

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

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

Uploaded CPython 3.12macOS 11.0+ ARM64

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

Uploaded CPython 3.11Windows x86-64

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

File metadata

  • Download URL: fp_tools_bio-0.2.0rc2.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.0rc2.tar.gz
Algorithm Hash digest
SHA256 c973be202f735f83709ce911018671d46f107a41c77ef74af6f539e779b2c30f
MD5 03133c8ffedd7f3bc02f1080ed6b7947
BLAKE2b-256 088062bc5c80dfabb3c87bb2b27aa14f3ad363b654ce5860b869253032837eef

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc2-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 3bbb11addc08fe5ce87c85d26ee009faab8263252bf18b1bd8ddb9d4daad1d80
MD5 e7d9028cb0242221318d13fed311b7dc
BLAKE2b-256 9ee9dbc011d98c15e47d1b9673d8c334941b0ce4173d61b334e9594512270a24

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc2-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.0rc2-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 a8620aaedc65b7243da5424b238c47337b103dc95f8c204bc93a674043220d08
MD5 313ffe667dafb80a01b6b43458fac384
BLAKE2b-256 de03726c10230b63e30b275d7595b422b5a0567a829a5d010014f0f69f5d41b4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc2-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 4bf3d362e5c3fe9d61c6c8b29e9a744ca514a116457548187293403875d217fa
MD5 4efe42349177541615fcb44a5d3c2b06
BLAKE2b-256 e14989ee2480b9329a878332f1879309b568770c54a1247ffd3a5a5e28535c74

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc2-cp313-cp313-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 de1b02963af45978846679894b4ff020dbf1e1106155637a92040bbf2284a064
MD5 9bdf7e45eafa049a744f3ca3d7273fc1
BLAKE2b-256 50c934d5837a1fa6914f086eff06221e79fcaeba2b8c0fc6282d0ac2bd8ed3c1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc2-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 0bdab5f3d4a50789016308f1714d8f26da6f721a284ebb5f7a30890351edb24c
MD5 2b53d5a4764e4fa3a91e58ab3d0c4430
BLAKE2b-256 b52a4ce2201dede17a9c34c9d14e11dd30926421c9a73a9da18700f9af8d7fbe

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc2-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 b48971aa8dbb1597295245f9825e353e2af3e6c3bbd561f8d07a48dcdc6b3b6b
MD5 4f7d6f2ec088250fa52e00caf84ccebf
BLAKE2b-256 653357be6f88119e605ffec8293603263bbd97310aec9ebec88d5eef7a70f624

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc2-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.0rc2-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 4b62af5ec4d40c4dfc518e2edf31df87331696638d7462d8e91dd843caa60111
MD5 9d3dfe916e93342b990c807729c2755e
BLAKE2b-256 1919e9533a3c94fc6b4b518440bcbb421dcd90d754b7bdf881646e0ef298f8ae

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc2-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 43b4b233eee28aba4921c0e4066698092686c100e25bc32ab26a803d593281ff
MD5 06a1b7acb1e7753d074bd4b3f64feb7f
BLAKE2b-256 a74bc658fc3f6dbd108f32950a8d96d563c6708837d4daf65b008210413bc827

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc2-cp312-cp312-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 53735de8d2ce398f8fbabc39715fec9943cb07ba57c3fd763624cc9403ddccb3
MD5 9a267fb8f6db2247bc5a0e11a6342485
BLAKE2b-256 3abeff0c54570a390f475f719251a96eff680498962828586d58ac4765b760fd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc2-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 b33010cfaab2df5858000965f8a81c8091dbc7d7f80b1018a977124b71e8ad27
MD5 9656dd2294dc154d80fe1f3e18ba2695
BLAKE2b-256 85e017b0ff85224d52d51efb2ab700f120536b25da91a8301ea108f9e9c84f47

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc2-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 00bd0bc17b366ffda5cede53bc5c3612f3e9402603712d079e337a306f88d4f2
MD5 aee1c53b0f7b694ffd809474cd99e971
BLAKE2b-256 e337d67134ff785508167316478e6c97a1f05e47a0fd0004bd7308f07be33c46

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc2-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.0rc2-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 4b1d570ec07aca056d296e13546d13b779ac5d4f8c1ea9e25aef83784b50ad25
MD5 033e48abacc932e5f503e0ebed55c7e8
BLAKE2b-256 2b65ff4b70a7115d51d346d0dfd0d22c5fe07002a8c4768fe81fa4bbdd853fb9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc2-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 0f37a02281b503683cc9a5951bc314264158ad160b1b21d962f8867d06cb6124
MD5 125be248b8125db475b789e14461f855
BLAKE2b-256 6db3413bc4719870244554213bbf8f8e5a9183709088e94bb795cd6f19bebe9e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc2-cp311-cp311-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 7992dba58e1eeffee572893f6e08db6bf016043e5015f1b5b7eb82c51f9ee6c5
MD5 2ccdb2611d9256e3d94a5084675d4b94
BLAKE2b-256 9ff96952985434afb8dcb67a4a7135827723fadcdde8cecf3fe8b9a3a811bbcc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc2-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 b0b10b519ef43f508939fee97737ab61f282a9be0a7f8273e5374871d2bc0588
MD5 2db276cb5aeb396dbd2889b8bd5b134a
BLAKE2b-256 03d438e210c3a0fa192b0610c560310bd2ac48fd5a804ea3e87b9b4ecfec4d8d

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

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