Skip to main content
Pre-release

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

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.

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

Uploaded CPython 3.13Windows x86-64

fp_tools_bio-0.2.0rc11-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.0rc11-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl (3.0 MB view details)

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

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

Uploaded CPython 3.13macOS 11.0+ ARM64

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

Uploaded CPython 3.12Windows x86-64

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

Uploaded CPython 3.12macOS 11.0+ ARM64

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

Uploaded CPython 3.11Windows x86-64

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

File metadata

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

File hashes

Hashes for fp_tools_bio-0.2.0rc11.tar.gz
Algorithm Hash digest
SHA256 91a9269bcc1a905114179eb1de71ac0c2f2b86db6886649a899a657f468c7b97
MD5 f1d6fb4740eaeff5dfa197e4f44121b6
BLAKE2b-256 2e6a947f0e7a649680a6366410e3d00697842489fc1168d0286374f23f1d5c11

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc11-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 b6806edbed3c93bf177c590503d9371c4f421ca38e52732f4dd75164354eaa5b
MD5 0965d93807241ac383e6a9410a221111
BLAKE2b-256 216e0aa629920e646208bb46cdbb74976ad9166fd60a82ff548588f6216d932d

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc11-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.0rc11-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 152c6b42bf5e89f195d2940fe3e2c403fe96cfad0eec2b0eddffc5162d6178af
MD5 2d469933a1c3fb7b2292e783c1d78864
BLAKE2b-256 5b64a563a1d885ebe251b7626391cd92114c1125a59a3f77c0a36fdee46e8f5d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc11-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 4f2077a3a60ca12e1037fd0c89401ea3a5251fb4e043da4f4f14575847637ef9
MD5 f50d3cf84cf6864a444efd71b28685ee
BLAKE2b-256 2c38ea57f6b80560217dc672159a2c9cd06da73b5d1e10f239efaa9757daff19

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc11-cp313-cp313-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 6addf68817996df43d9806c30563c3b30d2bde44124828a46fdc66e4a2ae4b46
MD5 03d62f429697811acdeebbadfe3d389a
BLAKE2b-256 c7c3bc75313e052804d6a1a61fd251e02b6dd1c2713458048fa815c22d4ae1d8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc11-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 5b75fb8094d0b1374046d09aaa49ac0e23e8b74ad077f53cd0845ecf4c48a176
MD5 b3485cd44d80d6e9ddb6318d17689eec
BLAKE2b-256 e1ca685cd8dac0bfe37a93f0a00c1e8e1136fe425015bb498b9dec49c64ad8ab

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc11-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 cec77215d60677614c68b3165c9181ec6f3b9f337f258acb1d5c625ff14e05ca
MD5 12adf205b2a6b83d713febffe39ece59
BLAKE2b-256 e3a43692e03b7d9deae4cbd170a17696cc0f7655e28bb87d32bbaeb49b89831e

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc11-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.0rc11-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 1f0f391c85a48edc4c05521b800976666d75e7b05c479eb8d94ef596c8f3bc68
MD5 21a9fe11780ce6041bd8189de7fe1450
BLAKE2b-256 93c3727cf877a00057a68109d932034b750c497a43b24bf77d0d6118b8d84ad7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc11-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 22887740f0cd9d4417803f913c2c9db06043551b50745034f0f2e73ae7c902d3
MD5 0b82c7adb15dd49cb48d9fd0d73bbc92
BLAKE2b-256 dd12887ae3c00751c74fd669dc79563092719cae10ab613c2f94cb93fe7ee7d1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc11-cp312-cp312-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 5d97b01ed513d24fab8ce21159ee9b2ab6914ecf9818db08a059c386190d2023
MD5 5c55b2110bb2af207736409e707bd136
BLAKE2b-256 23deff7066b7ea909b8389ae47b34ce83e1ddf3f8a99d0d277ea8a88b64dc23f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc11-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 68bbd0adc7dfbef0101c22f1e6b43a41105509025d299a97677234d8ba5aabe6
MD5 e4cb898c286c3f3b305aa45701d28e81
BLAKE2b-256 eb3c5aae72c657f2c0637b4e5301a3648739653571f7ca81f7cee753bcaa8240

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc11-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 e44d2d4729bfc4e9663ff5a1ca419f98d0032abc82e6756bc4ec347630f0a3d4
MD5 cc1baa346e9442809d3409af582d81bb
BLAKE2b-256 076fc67929e1d7d04097010c213f9363e08ccef8e901d7e74d966f5d28eb2180

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc11-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.0rc11-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 8fa562cd845825771058e0438eff2cefe5f82d9cdb458d9b76ad6f845d4d43fe
MD5 111937d177b2707d65981d31e27b8f54
BLAKE2b-256 ac712f300f4417a0a42d1be5034c68dee3d25535b314e5b28e599f5983058d8e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc11-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 5eb17e09fb92c4dbb1e0b025815394838e96b4b20da378d23ac064cfb2386c56
MD5 33fc7489c8f494b36a88ce7814a13028
BLAKE2b-256 ca7e93728db12d02c72d1c69bbe6223ded0c72ed28443df8a469035d1473de44

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc11-cp311-cp311-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 54b67957492035b62f980a252f751b5114ade80b93a88c4e653c71b50f992a05
MD5 626a6e3e941011e57eef738657afaafe
BLAKE2b-256 55fdcae6213d023fa9404dd678711d6e35c2a14535072b50b96fd3e50fc726ba

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc11-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 522d7f278f9ecdb912ad56cf579759e2247b40a5787779567719c7dfa1730df5
MD5 5d3c3d079089f9a8341dd855aae7db04
BLAKE2b-256 c2ca381f7afa6f225ff09f6c01b9c8bbbf005e759f809b12795d714267f9e512

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

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