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

Uploaded CPython 3.13Windows x86-64

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

Uploaded CPython 3.13macOS 11.0+ ARM64

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

Uploaded CPython 3.12Windows x86-64

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

Uploaded CPython 3.12macOS 11.0+ ARM64

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

Uploaded CPython 3.11Windows x86-64

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

File metadata

  • Download URL: fp_tools_bio-0.2.0rc12.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.0rc12.tar.gz
Algorithm Hash digest
SHA256 23c17865f751bc014671c7c5037aa336371b1e3943a7be1cc8aceb053d545005
MD5 c5551d9ba184e97e24f7cb7e64e16585
BLAKE2b-256 d2b68de6c2b9c58f3f2d594caaaf26c954a55cee7353463146ff162e4696fae2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc12-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 205fe9dd1188f0a18c72c5536022921ed7bc2b881a92aab71fed723c64677b89
MD5 a97552a859c9b8d5d69ce9f4d00c06e2
BLAKE2b-256 cbc6ca6244ccb429575bae81502df8be4484dd32af077118a2a524df8c4aac2f

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc12-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.0rc12-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 e3758ffc970fbb6f450b36488a9e9ad24705e8a5d313be2531c522c924fb5a13
MD5 3cb0782755c200b546d440bf76cc4d7f
BLAKE2b-256 5af53e87a7f7c87be7fbcd39683c2494d20af501608d7bad8330674686d3bbea

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc12-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 9f8659981d7120a7401975b771c4983102ee8c2ed541ff2233902259e7640376
MD5 cf47447406b5430e5e21abf91f8f3d10
BLAKE2b-256 bec4bd7e322ddca002196940535d61a8e84e1efe86fdedd1ab93d6304ff1497c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc12-cp313-cp313-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 5a16d4c7fb4f84d63066dbba36a08e01f122a4e0ffd65eab4fc280372643f4d8
MD5 72514ccaafbf4fe59c952a28af4c23b9
BLAKE2b-256 e98f6b30eadc72a6358495a1bce49b334c450a672db1b6e688d099a10b34a3ee

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc12-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 064b71784a3e924ca52d91d4f6aead66e89dfda619afa266e436bf8d0f9663c4
MD5 049499be08eeaf569c27ad8706bf4ca2
BLAKE2b-256 d843ed811bb8cbd455e4d3ac3e769fdd61252302ce4c12f6bf45aaa416257265

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc12-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 4fe0c7f4f22acc5b61b5ce40e1a5903d7936834b985b69ebb2170183ea965138
MD5 37962bc36527b05aa5b710fb9a92629e
BLAKE2b-256 b8d1bb803c0551bbfe9410a602583cc4055db577d0c1cde83658ed9761faf463

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc12-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.0rc12-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 27176708fc087cee6796110b3188a0948685f2f65fa0f3916f63353d5eb86a63
MD5 d7106149aa7e6c7ff62e63d859474c94
BLAKE2b-256 0e0f1884efe5b448307a436fe983604c3eeae44d2da9b2760804410052b3af2c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc12-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 2a5ae1089559c86ae82331ab3a92a953323fe4503a0f04236e8d4665799d7010
MD5 e805d66d4f2c33f0c1fc9c5a29a824b0
BLAKE2b-256 6f803a78ede1ecd1753775a2e478e14f12738c79b2da840ff549b60d341fa483

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc12-cp312-cp312-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 15dacf4e3c5d154db8158238f26a424d0fe96d41bfeca0031a16cf5b9c2ad57a
MD5 609208d42d372f512b3777dea2db0ed9
BLAKE2b-256 52279ba5e8316b2a4cd62bbe6f098b4d22e6a4abf66727c28abbe95452085064

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc12-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 cebfc36e8444a9f3390b3e84edda191318312dfaab4edb34a76114428f6ea389
MD5 35969cc3a6bc3b3d08a29557e6628fc7
BLAKE2b-256 610baa06e705e0c307db35b76f9a5ea10dc6cec66ec8d80313f6e0d1c6551a3f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc12-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 5815f32b84f118a8e6bcbaebdc6aaedec264eb8b7cab87045dbaa29709d25651
MD5 9c8d90c4eb436e29a3f3f9e761edcf64
BLAKE2b-256 b36889ff0925c4649de0d8e8ec5657fcab4616376fb2e26ae596e0a8ee66bca9

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc12-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.0rc12-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 c08894a18106c7bb1de75e944c3e025a29535ff64d63810d884fba222c627b3e
MD5 d453f0df7ccb3fc147b61913c1f34514
BLAKE2b-256 15aeac82841dc7236aeaaadf499245f5d74d3452e8beef744133eea63bafc905

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc12-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 ba4d770dac70b67cde7a092dce2a6c46128c12a6ed00dc7684c5b0a68a155ac8
MD5 301cc8625ade2d9ef8c2c396bfc3962e
BLAKE2b-256 fbe4d84b94bb22dce0ba75a0cc9ac3d2f91a9ffd281ba3a49ff871827a6041e2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc12-cp311-cp311-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 5b2d655e3926b9bbf3152a8b65b965068fcc69dfbe1c3721f90e440e94727e05
MD5 ff0f5ca79cd7d70670b747231ebb93a6
BLAKE2b-256 df8aceabe8dcb10312dbba3402a299c96f7141997884d05c906434065d391a1a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc12-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 7ce6fda5a4bfc2c07624bd799cf5689434bb64e572a615b18701015783623583
MD5 80343137f9e9758f3af8f55147109258
BLAKE2b-256 caeaaf9d42fd7fe6695b00d9d5bf86e422f0867515412f7c5c10ee1a188f21a8

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

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