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

Uploaded CPython 3.13Windows x86-64

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

Uploaded CPython 3.13macOS 11.0+ ARM64

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

Uploaded CPython 3.12Windows x86-64

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

Uploaded CPython 3.12macOS 11.0+ ARM64

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

Uploaded CPython 3.11Windows x86-64

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

File metadata

  • Download URL: fp_tools_bio-0.2.0rc13.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.0rc13.tar.gz
Algorithm Hash digest
SHA256 af9fce38d865a8ca6b0e4b9dbdb8d623018ff37865d1aef447cf7865dfa9d5aa
MD5 a469c32036437abb2ecb9bbe006df2f6
BLAKE2b-256 5bdc6cb4fabef6c80cb7484b6bebe7c7f8df3dd6def9bf75f2bbd38323b061e9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc13-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 e1bdac30a0daaadce19747a67d2d890986fed0de904e71a62cc9ab4c6964fae6
MD5 aff5f67877ae91829c9a20ff86285087
BLAKE2b-256 f9945c13ec81230ec51e989a341b7c805e58b2376eb64911bbcc50c8fd86c745

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc13-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.0rc13-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 881381f723876631452f656ff17d7f6a83d8fcb557d09ef40d16877b2af14805
MD5 16260159990c2cf525fcd48bfce595f5
BLAKE2b-256 eafe0e46f711641e412c15ee0c341c96b8dfd26396da0a6bb826bb674131414a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc13-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 ca033ff79c210deea5f0a5d76ede4600cba53082056872d3b7d9a25ef65ec588
MD5 52fa54781c1b0414491dd18e01d70589
BLAKE2b-256 9f9fb2f1fa1d14d55ee337ac13449011393773bc0a59e8254c30981cdcbca260

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc13-cp313-cp313-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 e44415f361f892bb6ac2fd69e5bac4fb577c05ed584ed8cd8945de2eaa3220f2
MD5 1e06e56e72bf15333c10190fb7f2e6a8
BLAKE2b-256 acfe86340583684cd2ed5798c2481c30a4c0fbdcd4869a656e56ac0f3cb55b9d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc13-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 cb70ed7aa7aad7c4ff81182619aafc5b01f4230da9d546186f4fc0eb3cc2c81e
MD5 a00c40e82837620810ad4f7f4fac9e2d
BLAKE2b-256 bffc90a9bb3a88a0b5acac83670571a8216bb2e1f84685c0287e65e895123b09

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc13-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 67afd9bc73b472f17b584aabcea57ee9f63568cba937807fdf0a3e9fd2c813ea
MD5 f3156308709364edd5a5e83f88814783
BLAKE2b-256 a98b8f02f51bca12a8f40442837f3b55c94db773f8bd1c129cae3ba0d9817c9d

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc13-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.0rc13-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 12bcb45260f7d7caa6bad7f91196df959370b816e397a50fc483738797da0de7
MD5 11418691019d119e46a6a4bceb00df90
BLAKE2b-256 cf05f929b927dad9e40ae6ae530a2bbbee4f4f39bd609bf75448009b4e81589f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc13-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 0fc342feef9cfbeb7219318253890432ec3b78de2d19258d17e01b23dd8f0bb3
MD5 c7a90f3bc6de6565e7614b62c3aeb732
BLAKE2b-256 b424c4dab60881ffb8206af12dfcce823da7941a772e32ed4f124239dd1dc286

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc13-cp312-cp312-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 2caf72744b1ade49e82d898c983b9a0647a369b8d42a61e9584bcfec39e921ea
MD5 93dd234b058d6e723d19a46e26739221
BLAKE2b-256 cc9c05a36f1e26616a4d89d0b0a5c0a78c2a5deb74e31d2d90143e5b31987573

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc13-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 21e5568bdc1fd47d15867bfb45e83703ea6544eb056cc73f71f692bac4176aee
MD5 625c01df48c85a97898f166ca3039690
BLAKE2b-256 351f27b20d670a153015dd0143ae10f9cef02adaab6ceba2bf3836af84e5dc0a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc13-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 edf9fc68969c3ea913c63a91645a98085e1752cdffb2f3d15b1201eaf36e7f4a
MD5 608773c4588e7de2fef64c802fa21b18
BLAKE2b-256 1f289e5168b82cf715691e7e86289ff3aafea7bbd3e85cf7af037b171b8dafff

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc13-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.0rc13-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 523ae289c571799301f32b5831b458bd247a9c5cd9099bbd4d2978014100ed26
MD5 78882cb9374075995116d616c6d74d66
BLAKE2b-256 72defbe96d9b3a3a71c9582ad0a15953d8bbd189a7ac945be282764d960feff4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc13-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 93f0d43c906701a5db15874fdcc73fa31ab862774362bdcb03b41fb30d54a2aa
MD5 6dfadff218e9a92159d7af4dfccb2f0d
BLAKE2b-256 eddd2ea078c78a459b88aaef0d6756fa7f47a16a96fddab35ddd94d05113e95d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc13-cp311-cp311-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 9ca1723560d4db1f88b3ddd6813d8a910fd862e1a1f9221cda7369d29d49116e
MD5 0e2ac205504d87fea449abc19873ed8d
BLAKE2b-256 7f0ead578a44962bcfcf725b7e01cea9b11ea59593afe1923e1a56572e6d688d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc13-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 48ce7ff95b01ba2d97ffc7e0ac9663ff5966ec1bc0a9f99c192b6c483be6b3dd
MD5 08752c17eb7f0b3bbc686b71dc181394
BLAKE2b-256 f66b2c928e73972c2d3e4305ff1213bd2a86254b5d42b400f2ba4b4476e97442

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

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