Skip to main content
Pre-release

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

fp-tools — regulatory footprinting

PyPI CI License: MIT

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.

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

Uploaded CPython 3.13Windows x86-64

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

Uploaded CPython 3.13macOS 11.0+ ARM64

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

Uploaded CPython 3.12Windows x86-64

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

Uploaded CPython 3.12macOS 11.0+ ARM64

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

Uploaded CPython 3.11Windows x86-64

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

File metadata

  • Download URL: fp_tools_bio-0.2.0rc10.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.0rc10.tar.gz
Algorithm Hash digest
SHA256 f0ec298a5704d4f5b95ac89ce2c8af96abe8eb9c0bcffdcba4285a493d9f9b9a
MD5 4a8758e01959e92ea4a9ed86099fe028
BLAKE2b-256 3a82a26d037e2981e3b8ddd0d1d0a347b783bf26df3cc7540088462b5b189a48

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc10-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 1604ab30ca1cae25484fdbb8983f51e97007bf1b652b940a9d0d9627a95c0a95
MD5 3f68a6973ee0f7401785546fce854d48
BLAKE2b-256 6bc3560c2e3f45fbf58dde5e22905bff260197045da01915ca47cb67bacc3da1

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc10-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.0rc10-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 111768fae17e40caf35b0d5a078c7f9cba62bdf530dbef6d4e9c9ebe855e0707
MD5 100b96b9845fcfe743b53b69d83527c6
BLAKE2b-256 b5522d1480bb297d5376dc7b85aad7d4e45e127ca1bbe4e8c2b59a56a5721905

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc10-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 06f9f5622cb72c91fad8e4b837826bb640207558db89e2f59b5fd182f98bf255
MD5 ff6225af91951509f66e4e92095e18b6
BLAKE2b-256 b7b1971e023eab05f21824e84e17fb917bfa49460a8b95039669d89bb929b17d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc10-cp313-cp313-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 50ef0c7644a099f201937b603937367ea051557e2cf03e1e55f5a245b073a885
MD5 a9113e4d1bc504c1ab8e99a9cc1c5cf3
BLAKE2b-256 2a5b4b63396742973f8cc540ba5f94ef00e615232d71a00b85495e34ca013371

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc10-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 c70a1e170ba63ec0755b4b159bcc7fc342e25264696454c3cf78a4906b812d09
MD5 8641518fad7c7562c29b4b80e12071ba
BLAKE2b-256 6623d967dcf0c5767e450a1c6a89160618837464c7f09d803ac18abbaaabcdea

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc10-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 5c7948fa5a33281254bb5cd1080041037ca1429dae1aad195defd9f28712a719
MD5 d19c0cd299216f4af9f3e1de79b595a8
BLAKE2b-256 d2cf25217685a24740101353c1b9b6b86b4b5201860051e267b706a6ac9367da

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc10-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.0rc10-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 6e22dbfe4d62a2e5aa7c1db059daf8bc3b3686ce158bba28bd7768617b19143b
MD5 ef27925a250c7affeed3eaf45b1289d5
BLAKE2b-256 960015ac790a45858b6a42c6fc71a028fca2714164bc71836c39057be787730d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc10-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 d7ed02ff236d907c5be4a535ab46472c8dfc059df866b754909dd52cc01e61cd
MD5 a27a80c8196fcd80be6db3c31bda6fb6
BLAKE2b-256 cdca4207794fdbc1c15e506ea0a7eaba778cc971dcfe2c266d179f54531ecb04

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc10-cp312-cp312-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 5065b52ae4cecd450c30e33043181928e8c3c7a8e5679cf24cd06bf23fea075e
MD5 dab636b3bf3a9355c4cc0403526a8233
BLAKE2b-256 971af8f7a97a83f6a9eb146bc6f2a91b8cf42209ae262080c56d18bfb0651a68

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc10-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 3995c2d1bd21891d6360fce8fa20deb36b3ce49ebedd9c291515dfcd3d01cf11
MD5 e2f29caa45918f87a43cd09ae7ad0cb8
BLAKE2b-256 63ef2f2ac2bffd9deb16e8d4e448859a7873bd44770cab79c1f41b7d60e01214

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc10-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 ab961a0f23b7e813465915bde17d7aac35657c429f7c2baf29a21453aba64c3c
MD5 b950b84b0c445c630fd1e1139193a09b
BLAKE2b-256 d688a5a1d18606191cc2bc4dee065f32d45e5219ee300f44441056bc2c4f329f

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc10-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.0rc10-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 2560e51a2ea6a9627a11d5e230a1c5a81b03c2a8118296e76dd498b6e4a6c147
MD5 f1bca4537417a871f09f9b8c97252f38
BLAKE2b-256 714661f27b911406357883336dc4e7f72d5fa2d0c25cb8daf32ebc3911dec65c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc10-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 70243a0d6ed463e44257e07e2c19fb6a7890b4176b666426cdc883429ce8145b
MD5 f7497c2feb738b2daa1b70ae8a83b5b5
BLAKE2b-256 926dda7efe67e83ae624381358abd98ea605880477e05a040c0c574da50b190b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc10-cp311-cp311-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 288a772c2bedbacdabe5bdf86d1f7eef671396451a6240f5ca8baad28d4ffecb
MD5 4196c5cbca8501866cceb1dcd73659dd
BLAKE2b-256 ce2cf0a5bffad751299f5e8efe79ad7a6a6a3efc34174f980cd4119bea5dba31

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc10-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 428a959599d8943c729e9fe9cd4527a1961cfeb59ec50e5786d90d6b78e705f7
MD5 1ec100e797d2d054a3985ec6878a0b29
BLAKE2b-256 dfc1e7d21721e7c0a1fe76cc7a0c57d12916e834401e7ff72fd8f0bf0829d19f

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

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