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 ATAC-seq bias correction, footprint scoring, motif analysis, replicate-aware comparisons, and single-cell footprint signatures. The GUI and YAML runner call the same commands.

Install

python -m pip install fp-tools-bio
fp-tools-gui

Python 3.11–3.13 is supported on Windows, macOS, and Linux. Core analysis and the GUI install from wheels; raw FASTQ preprocessing uses standard external bioinformatics tools (WSL on Windows).

Bulk ATAC-seq

bulk-footprinting runs the complete analysis from aligned BAM and peak files. FASTQ preparation remains available separately through prepare-atac.

bulk-footprinting \
  --sample-table samples.tsv \
  --comparison-table comparisons.tsv \
  --genome hg38.fa.gz \
  --blacklist hg38.blacklist.bed \
  --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.

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 prepare-atac, atac-correct, call-footprints, match-motifs, diff-footprints, normalize-bigwig
Workflows bulk-footprinting, sc-footprinting, run-yaml-workflow, fp-tools-gui
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.0rc1.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.0rc1-cp313-cp313-win_amd64.whl (1.6 MB view details)

Uploaded CPython 3.13Windows x86-64

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

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

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

Uploaded CPython 3.13macOS 11.0+ ARM64

fp_tools_bio-0.2.0rc1-cp312-cp312-win_amd64.whl (1.6 MB view details)

Uploaded CPython 3.12Windows x86-64

fp_tools_bio-0.2.0rc1-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.0rc1-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl (2.9 MB view details)

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

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

Uploaded CPython 3.12macOS 11.0+ ARM64

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

Uploaded CPython 3.11Windows x86-64

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

File metadata

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

File hashes

Hashes for fp_tools_bio-0.2.0rc1.tar.gz
Algorithm Hash digest
SHA256 1b6eb37493e5bf88699e88f805805185fd9888099fecf06e8f1c381d423356fc
MD5 5d302f6c5d9930a718d14833b256c2b0
BLAKE2b-256 49896dbd7b5b98dfb16543ed814b729b693727c0f0ff858463b0d2e7e3683465

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc1-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 38d9ceb8bd91dfb9a5d0b6b7bda0d64041c69c232fc3209ced938b1aed7dcfbf
MD5 7f79a4eab06b60155db0ad6e35b20fd2
BLAKE2b-256 088cfdde66f5c2fb4b57918d2e5d2415bbcab6dff0124e6cd5e968a085b13643

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc1-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.0rc1-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 66444faf3f6b1cf00c365f57dc7fbe28458a5b570291e6d4dc57b04b03f55973
MD5 ef628fda3cb34399063176223fb73057
BLAKE2b-256 fcc5696ae6c5dbdb960519fadbfdbafba16d57523f6081c4a5b129db6b6a3e53

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc1-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 0a4352aafc8e49b6fd6bed863d4f2ed884b4c8cd6ec034dc0f3a8ba64a740936
MD5 80a3a9d00c883e15df8d988fb99c9851
BLAKE2b-256 047f4599fb2e2ed9f916264d5c11209580cb7e06881c67aaf43e740981ad5fa3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc1-cp313-cp313-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 9ff176bfa61e1d0cf4b66ac1db211f10f09e2839a94893448b82dbfdbf87ab44
MD5 94a0e8377bb880c01126c21d1229f246
BLAKE2b-256 a53931339941e2c7859fa32b41c734fc8493e8ab3ef1f77d192ee5f63b6518da

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc1-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 00022a15ee6c17a6fafc702ac6efb2b8be39eb8200fcfcc8c5825f5f275feb35
MD5 74f32d13af3181fd21dc4c63bc1a6477
BLAKE2b-256 7e926111de60b3f2fdf8cef3c4ce3e7be5bfd61e3010044b61882ab9c1778d9e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc1-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 b0cd037158176e0d86a0924bbc16bb00a84f813fc16c045eded55922358a68f8
MD5 66d9a56f9449d204aab4928c50b43647
BLAKE2b-256 89ae34d3a1e8b083e31c3628d847629a6a0abd2970ab1bd8468228da2807c17a

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc1-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.0rc1-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 654c96e70fd241850fa054c6daa2ed34142d441fbbca99e5c377c6c10f806c15
MD5 6a7b45f1104108d73e035c4c1f979ad5
BLAKE2b-256 70d73eb4c713842de3ae9e19e0b87ce3297f41f59672376b6450783cb6697968

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc1-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 a62fa8b67313bdd4b249bae17fff44c139f0c83fff3269814dded748badcf8c8
MD5 90f9feb24f203ef565c4bd1cb9be6918
BLAKE2b-256 d4b93bee63d725df8f1f923e966975208c689cb151601b3112d6cde0a591639b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc1-cp312-cp312-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 af6f1e669f578c2f6ab91a1d4609630441ff5bf9ff66f5ba697fab4dd43c3413
MD5 568a7be7d8589e298c175d8d77b783ed
BLAKE2b-256 b31814619f680a228ede1583f8522d52d0a560e350ba9ab6548af8a8d1d39521

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc1-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 8b91a4bd4b4959d139bcfd7e2333b95c68a40e6850f86b53abe2279df00081a2
MD5 87d4854ea53d2b9d7e06e0e7db6fe611
BLAKE2b-256 ad17eebaa1ab01991fb6d73bb1d36d9b4cb2436a526478da27eb6f66c7ac6576

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc1-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 966f2f33e7c67ed08ead50562c66bf91ed309e678f890ecd9683b70e23c4036d
MD5 f87e292f5b8a82795e5c6acf6f754c2a
BLAKE2b-256 c96aacba728d994de524a0c74229467b133828a11bfd2a57ed5ba1d95a084f50

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.2.0rc1-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.0rc1-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 a8fc64204cc0b9056ac39b63b8ccc1fcf59c0984bba82a9a1f31c4bbbdae0c88
MD5 231ab4d04a0f463c6ad26538b027a14f
BLAKE2b-256 96e3f4b43da4e0669897955b699c03de87664a1d3feeae9f3932975280e43266

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc1-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 eddf2edb5890e77eeb14e9d675570ed25ffdd53864f4d5d29adf15b2d6e12b39
MD5 40cee9dd1434106bcf3765edde18cc82
BLAKE2b-256 0537e1049a1ac45a324c8b3c5e5062145960b1206de20e1884cd21674962b35d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc1-cp311-cp311-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 ea94874b32a9911b3b6d0011af7c4fcac7ca1c7c00896fa8900cddb01a3c949a
MD5 0ee1aa667a6058524ab3ce2c3878cd14
BLAKE2b-256 c980dd242172d85c1af039245a5186c5fd27e0957c4387a54311868275cad7de

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fp_tools_bio-0.2.0rc1-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 829cebf273093b21097542a6d6de4d806d2aed05c27808d975351a62b7bfdb1b
MD5 36c964a960f4556d1447549197e34da6
BLAKE2b-256 e9d2da352ec99d1e4087166c5c69e2a2db65dc0df45f859f701f538faef677bb

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

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