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

Uploaded CPython 3.13Windows x86-64

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

Uploaded CPython 3.13macOS 11.0+ ARM64

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

Uploaded CPython 3.12Windows x86-64

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

Uploaded CPython 3.12macOS 11.0+ ARM64

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

Uploaded CPython 3.11Windows x86-64

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

File metadata

  • Download URL: fp_tools_bio-0.2.0rc14.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.0rc14.tar.gz
Algorithm Hash digest
SHA256 02fc8f68f562faf1c924b695d328e38b307234f621b745e7c82e9dd4a0de56b2
MD5 b9ae7e790f1b5e35a80b070d9657fe25
BLAKE2b-256 7aea4851981afa6ba48a4e0bb3eaf9bab53fa3ead6fcc581755c7d3ddd77ddf1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc14-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 098f4b056687fa9e48b24d1a050125e004296b0ad4a4e9ed587b5479dcf38aa6
MD5 61ea7bc7c4ec182cbbc4b6715413b2b0
BLAKE2b-256 68dde25e0e68715b2af3fe1319509cc78cecd23e971c130f762eb0969548f615

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc14-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.0rc14-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 a7d29675f525431d54cfd3eff086f48f44d7b7e424259fe559137ee4cb9167bc
MD5 9a9a9cf781b835e1fc415858c978a7cb
BLAKE2b-256 81a30caa679f1f294d1b6732948a97b9cc41c28c5c20daf1203ced916bda8dd9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc14-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 a8893700add6e34499a84f09bb59d2d77c01b2ce9e26767633f5719aa2f3d555
MD5 9941a6b55735ce1d75952a36fc47b0eb
BLAKE2b-256 ce667d7edb7c32f3ac2e782ca2a89e496fd3ef52a063a4a22f030546f64bd97d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc14-cp313-cp313-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 487ae52c368aae03e4fd8dd598d13b741dd19dd818347e1f38c422af346a01f8
MD5 8275c9158621dbbfb5c110d0fee0886c
BLAKE2b-256 53c725ba2ceaa2b3690b76ef14950737af9cc6d872a26f918e3505b35fa1560a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc14-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 903ac7fe1f3fcc8d7f38d8f5d5f536c1bd0fd8404dd441d952e3fc6d5b4307b1
MD5 5cb9b07c571352d704afc30fdaa6d415
BLAKE2b-256 388e830ec2b5140cfaafb0913cc61e609ac0b23be98935e878cd64b4f73d8234

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc14-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 cc099e9b0a0a38b232aba54be8f21869551dbbb250ded63e8ea3c1ceb1a28bd8
MD5 b3e19bce08c041ac4a9e5413974175e8
BLAKE2b-256 f91da47afef6243183e8b34f93241757ae564d276f21adfdb403dc267b3940ea

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc14-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.0rc14-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 e05d53081edd92e4a9b23e08b54213f1a3fd0779218a070affc38fc80928d5a7
MD5 7510feb5b776f35bb9cec74c0c39f7e0
BLAKE2b-256 4ff0d7a58295c48a6223e59f10bba4eb32d2d2be6c790b14d19acab3cbbc9aac

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc14-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 2ffaa2ef81ca35145977ebc2d89dc68f60c8fef29b382adccdede4d328691a04
MD5 831d29971d8a880524ade787053bdbe7
BLAKE2b-256 a3babb524261c4f473fd95b0e79c268ea364a6b4b5a9065f0d8dd263ef25380e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc14-cp312-cp312-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 477b24ecf2e857b1035472118ea1efb1995811cb426c812480e636322a22c63e
MD5 089f69933532a203aac3c3b2c43ec017
BLAKE2b-256 b9b8e1d0f519935518a74526d87059c2efebfb1f1e0f36910a8409a7e9f01aa1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc14-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 cb56e925f6fee3ae29c7cbd53a2a5fcb6c390922029d43af89de6a3e8b3bba39
MD5 82a57c153fed3f5d58abe87ef5d7fc4a
BLAKE2b-256 69c19e8b6081b2c5e54afdba9d74de797da94a01352044d4cdad9ee6bbde0c69

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc14-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 d42571de759e5fcadd298f11c1bd9b79474b7d9545f57fa38d0b78d1f674ed22
MD5 af235ecb9966329d9908d0b07bce2709
BLAKE2b-256 d9076dada65c7bb4dad2d223edd69e2d786d56e9f2e68f439f4da7b8e13414e9

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc14-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.0rc14-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 010951c8ce9dcc08395e8e1e5421f45ed2ad7d9f32b47def27d5fccd12f0ba36
MD5 e48f529028cec7e0457643f2ff14e62c
BLAKE2b-256 b6fa6b6771d098451805d66bd320803292c987e6723c4d9e9038ff99ea495ca0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc14-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 9c750595aec696c468b9ff26c328f3aa5feb81f4ab948dcdc370bfc840c9e11e
MD5 6c846c7fb26bdfbc44361e91a8367717
BLAKE2b-256 26f3d38aa6556ae830a9cc093237db68dbd2f70ffa23b55a7bdfabce03325c14

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc14-cp311-cp311-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 96d964143d66087fd19e9b4616bf5888632fd591c12c76711314966e134f2118
MD5 48895a054cdbe69704f819845b464f96
BLAKE2b-256 e698a33b58825ce903326a5308f1c73abf4ca5a52077b8e8105f78e4f09452e5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc14-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 2c24587542f5d6ddd84579f903795f2e0f89806b4144d880791969a7737fe6b1
MD5 517a183cf71dc6e453768fd7fb4ab0ec
BLAKE2b-256 13e542a1a4143f3e59ed8053427c086c5740693a5ae8021bc89de6390141774d

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

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