fp-tools-bio

_{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 build -t fp-tools:latest https://github.com/oncologylab/fp-tools.git#main`

Python package example:

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

Optional de novo motif tools are downloaded into a private, versioned cache on first use. Docker remains an optional reproducible backend.

Bulk ATAC-seq

bulk-footprinting runs from coordinate-sorted BAM/BAI files and matching peak BED files through the final interactive comparison report.

bulk-footprinting \
  --sample-table samples.tsv \
  --comparison-table comparisons.tsv \
  --genome hg38.fa.gz \
  --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.

Optional FASTQ-to-BAM preparation is a separate prepare-atac command on the Linux CLI and in the Linux container. bulk-footprinting, the GUI, and native macOS/Windows installations start from BAM/BAI and peak BED files.

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	`atac-correct`, `call-footprints`, `match-motifs`, `diff-footprints`, `normalize-bigwig`
Linux preprocessing	`prepare-atac`
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.

Metadata

Release files for fp-tools-bio 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for fp-tools-bio 0.2.0
File	Size	Uploaded
fp_tools_bio-0.2.0.tar.gz	1.5 MB	Aug 25, 2026	Details

Built distributions (wheels)

Table of built distributions (wheels) for fp-tools-bio 0.2.0
File	Interpreter	ABI	Platform	Reset
fp_tools_bio-0.2.0-cp313-cp313-win_amd64.whl 1.7 MB Aug 25, 2026	CPython 3.13	CPython 3.13	Windows x86-64	Details
fp_tools_bio-0.2.0-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl 3.0 MB Aug 25, 2026	CPython 3.13	CPython 3.13	Linux glibc 2.28+ x86-64, Linux glibc 2.17+ x86-64	Details
fp_tools_bio-0.2.0-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl 3.0 MB Aug 25, 2026	CPython 3.13	CPython 3.13	Linux glibc 2.28+ ARM64, Linux glibc 2.17+ ARM64	Details
fp_tools_bio-0.2.0-cp313-cp313-macosx_11_0_x86_64.whl 1.7 MB Aug 25, 2026	CPython 3.13	CPython 3.13	macOS 11.0+ x86-64	Details
fp_tools_bio-0.2.0-cp313-cp313-macosx_11_0_arm64.whl 1.7 MB Aug 25, 2026	CPython 3.13	CPython 3.13	macOS 11.0+ ARM64	Details
fp_tools_bio-0.2.0-cp312-cp312-win_amd64.whl 1.7 MB Aug 25, 2026	CPython 3.12	CPython 3.12	Windows x86-64	Details
fp_tools_bio-0.2.0-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl 3.0 MB Aug 25, 2026	CPython 3.12	CPython 3.12	Linux glibc 2.17+ x86-64, Linux glibc 2.28+ x86-64	Details
fp_tools_bio-0.2.0-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl 3.0 MB Aug 25, 2026	CPython 3.12	CPython 3.12	Linux glibc 2.17+ ARM64, Linux glibc 2.28+ ARM64	Details
fp_tools_bio-0.2.0-cp312-cp312-macosx_11_0_x86_64.whl 1.7 MB Aug 25, 2026	CPython 3.12	CPython 3.12	macOS 11.0+ x86-64	Details
fp_tools_bio-0.2.0-cp312-cp312-macosx_11_0_arm64.whl 1.7 MB Aug 25, 2026	CPython 3.12	CPython 3.12	macOS 11.0+ ARM64	Details
fp_tools_bio-0.2.0-cp311-cp311-win_amd64.whl 1.7 MB Aug 25, 2026	CPython 3.11	CPython 3.11	Windows x86-64	Details
fp_tools_bio-0.2.0-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl 3.0 MB Aug 25, 2026	CPython 3.11	CPython 3.11	Linux glibc 2.17+ x86-64, Linux glibc 2.28+ x86-64	Details
fp_tools_bio-0.2.0-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl 3.0 MB Aug 25, 2026	CPython 3.11	CPython 3.11	Linux glibc 2.28+ ARM64, Linux glibc 2.17+ ARM64	Details
fp_tools_bio-0.2.0-cp311-cp311-macosx_11_0_x86_64.whl 1.7 MB Aug 25, 2026	CPython 3.11	CPython 3.11	macOS 11.0+ x86-64	Details
fp_tools_bio-0.2.0-cp311-cp311-macosx_11_0_arm64.whl 1.7 MB Aug 25, 2026	CPython 3.11	CPython 3.11	macOS 11.0+ ARM64	Details

Total release size: 34.7 MB

Release files / fp_tools_bio-0.2.0.tar.gz

Download URL	fp_tools_bio-0.2.0.tar.gz
Size	1.5 MB
Tags	Source
SHA-256 checksum How to use checksums	`32d286fde1db07ccda5811f393ea16fca6984963d2a69d3cdea0ccbd2dc30d20`
BLAKE2b-256 checksum How to use checksums	`9b7065b06bc47c92c8d345c2b0a8f1e601c2c0f8308f71ea2bf192396aac6426`
Upload date	Aug 25, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.14`

Release files / fp_tools_bio-0.2.0-cp313-cp313-win_amd64.whl

Download URL	fp_tools_bio-0.2.0-cp313-cp313-win_amd64.whl
Size	1.7 MB
Tags	CPython 3.13 Windows x86-64
SHA-256 checksum How to use checksums	`864647af0a830dc7fdccf6e9ea3dbc907ce1f763609f5b0d01452f4a4d8dcbbd`
BLAKE2b-256 checksum How to use checksums	`e16c4f521e920cfa02e362592c8955eefe833a3fef6e6f7d06a549d5abf11959`
Upload date	Aug 25, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.14`

Release files / fp_tools_bio-0.2.0-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl

Download URL	fp_tools_bio-0.2.0-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Size	3.0 MB
Tags	CPython 3.13 Linux glibc 2.17+ x86-64 Linux glibc 2.28+ x86-64
SHA-256 checksum How to use checksums	`3eafd1bbb248005a06ed49399b563798ecb923a32792754212590e454806e6e9`
BLAKE2b-256 checksum How to use checksums	`4c3853840382e8f081d43e97a8a6fdf20708af012b98359ff733da695e2402e5`
Upload date	Aug 25, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.14`

Release files / fp_tools_bio-0.2.0-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl

Download URL	fp_tools_bio-0.2.0-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
Size	3.0 MB
Tags	CPython 3.13 Linux glibc 2.17+ ARM64 Linux glibc 2.28+ ARM64
SHA-256 checksum How to use checksums	`2e474a920cf60e521bfb2f33d0ec6cee3d33b36452523448cfeec7e7fc8960b4`
BLAKE2b-256 checksum How to use checksums	`6b45d3be00bf3e10e61d515b8e003648e5e47b81421187948be0bc3ac539dc4c`
Upload date	Aug 25, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.14`

Release files / fp_tools_bio-0.2.0-cp313-cp313-macosx_11_0_x86_64.whl

Download URL	fp_tools_bio-0.2.0-cp313-cp313-macosx_11_0_x86_64.whl
Size	1.7 MB
Tags	CPython 3.13 macOS 11.0+ x86-64
SHA-256 checksum How to use checksums	`e7a375cf66ee9f7a365f7358009ee34870a553b7cff0d5870b3c7d2e4b81079f`
BLAKE2b-256 checksum How to use checksums	`dc8f12912b78861553ce299a06e357c1decb877c685e6dad40ff6dd057eaf143`
Upload date	Aug 25, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.14`

Release files / fp_tools_bio-0.2.0-cp313-cp313-macosx_11_0_arm64.whl

Download URL	fp_tools_bio-0.2.0-cp313-cp313-macosx_11_0_arm64.whl
Size	1.7 MB
Tags	CPython 3.13 macOS 11.0+ ARM64
SHA-256 checksum How to use checksums	`420da66c3c378f6489739b3c044792c9fa0c5097ccf6795726591d64c3cf92b5`
BLAKE2b-256 checksum How to use checksums	`2e3253e39e626c5f7372967fb193039519ce917c5ea5ca66c9ea4ccd6d308d1c`
Upload date	Aug 25, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.14`

Release files / fp_tools_bio-0.2.0-cp312-cp312-win_amd64.whl

Download URL	fp_tools_bio-0.2.0-cp312-cp312-win_amd64.whl
Size	1.7 MB
Tags	CPython 3.12 Windows x86-64
SHA-256 checksum How to use checksums	`217c314ebe46e6d84b089de6616a8e845516958dc473f5d93ce97ef62348714b`
BLAKE2b-256 checksum How to use checksums	`195de49b7d5c82d793ddee1602833e50d1376ac6415d130d17b6fcfd201be67d`
Upload date	Aug 25, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.14`

Release files / fp_tools_bio-0.2.0-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl

Download URL	fp_tools_bio-0.2.0-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Size	3.0 MB
Tags	CPython 3.12 Linux glibc 2.17+ x86-64 Linux glibc 2.28+ x86-64
SHA-256 checksum How to use checksums	`c99d6120ba7486378c422a1ff9abe107400fe445c1ebe710534ff61156aad02f`
BLAKE2b-256 checksum How to use checksums	`3145e8e1e861ddd23f053ac02796e9984bc54f6724d07389c1d619b2dbceda82`
Upload date	Aug 25, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.14`

Release files / fp_tools_bio-0.2.0-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl

Download URL	fp_tools_bio-0.2.0-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
Size	3.0 MB
Tags	CPython 3.12 Linux glibc 2.17+ ARM64 Linux glibc 2.28+ ARM64
SHA-256 checksum How to use checksums	`8668f98ac1b51539514ff0fccc9796862610a762733169884cd2bfb437d8505f`
BLAKE2b-256 checksum How to use checksums	`cb7903c3e93b2a9c433303448bb2f1a6c2975359cf15508977095824e56e0a53`
Upload date	Aug 25, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.14`

Release files / fp_tools_bio-0.2.0-cp312-cp312-macosx_11_0_x86_64.whl

Download URL	fp_tools_bio-0.2.0-cp312-cp312-macosx_11_0_x86_64.whl
Size	1.7 MB
Tags	CPython 3.12 macOS 11.0+ x86-64
SHA-256 checksum How to use checksums	`3d9f8ec862969ab8ab68b1d0525fb5da4e8fb0c310dc56e28ae19f4822f306b3`
BLAKE2b-256 checksum How to use checksums	`08f0de9506ab42f1654522f53b6b3fb9b70c7a1e7be653be7af868512ee0484e`
Upload date	Aug 25, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.14`

Release files / fp_tools_bio-0.2.0-cp312-cp312-macosx_11_0_arm64.whl

Download URL	fp_tools_bio-0.2.0-cp312-cp312-macosx_11_0_arm64.whl
Size	1.7 MB
Tags	CPython 3.12 macOS 11.0+ ARM64
SHA-256 checksum How to use checksums	`f8f68a12bc70bc14b1b4b4554413462ee8e01ee452dde237b6844f21c6a69f29`
BLAKE2b-256 checksum How to use checksums	`c4bba6aee7803e9bd0077b1abf1950e76a32c6747f707482601d74730bee6039`
Upload date	Aug 25, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.14`

Release files / fp_tools_bio-0.2.0-cp311-cp311-win_amd64.whl

Download URL	fp_tools_bio-0.2.0-cp311-cp311-win_amd64.whl
Size	1.7 MB
Tags	CPython 3.11 Windows x86-64
SHA-256 checksum How to use checksums	`fae2e5280d4d7874ce65d9f794fe834d6af9d8a6f9d378d6e477f9fa0fdcc780`
BLAKE2b-256 checksum How to use checksums	`c2554aa0dd35c529b13fc2c8239495f671a9ac817c6151baa7c120f7db5f28b5`
Upload date	Aug 25, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.14`

Release files / fp_tools_bio-0.2.0-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl

Download URL	fp_tools_bio-0.2.0-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Size	3.0 MB
Tags	CPython 3.11 Linux glibc 2.17+ x86-64 Linux glibc 2.28+ x86-64
SHA-256 checksum How to use checksums	`03d5041d6d57a0df40fe1e52376429a5f7af2e6bfe57532276eae70d3fbcd468`
BLAKE2b-256 checksum How to use checksums	`c45a75a1c8e8655943235b41e8f99bfc71574a4645100d18e5250b4e0ed71689`
Upload date	Aug 25, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.14`

Release files / fp_tools_bio-0.2.0-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl

Download URL	fp_tools_bio-0.2.0-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
Size	3.0 MB
Tags	CPython 3.11 Linux glibc 2.17+ ARM64 Linux glibc 2.28+ ARM64
SHA-256 checksum How to use checksums	`d868d44fba99324a6550c98b07749257e657520de301f83ca80b597c853fa445`
BLAKE2b-256 checksum How to use checksums	`212bef02b2b6a0e3d79fd669c7526c0438744c02c31b8f0fc3c5f69015a9e667`
Upload date	Aug 25, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.14`

Release files / fp_tools_bio-0.2.0-cp311-cp311-macosx_11_0_x86_64.whl

Download URL	fp_tools_bio-0.2.0-cp311-cp311-macosx_11_0_x86_64.whl
Size	1.7 MB
Tags	CPython 3.11 macOS 11.0+ x86-64
SHA-256 checksum How to use checksums	`66b1e530a6dd8ccc81ce05698e4311b2192a0f4fb181ed07f1dd20e130498cb1`
BLAKE2b-256 checksum How to use checksums	`2a3bf8c74661bc8c558150a7f4cacc7fc312660c68e77bd93f76a7d4fa6d6658`
Upload date	Aug 25, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.14`

Release files / fp_tools_bio-0.2.0-cp311-cp311-macosx_11_0_arm64.whl

Download URL	fp_tools_bio-0.2.0-cp311-cp311-macosx_11_0_arm64.whl
Size	1.7 MB
Tags	CPython 3.11 macOS 11.0+ ARM64
SHA-256 checksum How to use checksums	`80d914b491183d39a95d252241029d91a887ad084f116d5c68470ea967c7fed2`
BLAKE2b-256 checksum How to use checksums	`6bd103010d02c77f35b2a20aaffdbbc5b14fe5d6a1e2b7be5e0bec9f9b2c4951`
Upload date	Aug 25, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.14`