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
Built Distributions
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file fp_tools_bio-0.2.0rc15.tar.gz.
File metadata
- Download URL: fp_tools_bio-0.2.0rc15.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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b1b4462dae4704809fa70e01475aeee48a0685d8c8c1091784afee32530a6996
|
|
| MD5 |
4616c0e5cf066152eaf75d911470e59c
|
|
| BLAKE2b-256 |
4ad1caf5654ee59e807115d563986cbf3ee08d1480c96d10a5077b3277cb0fb6
|
File details
Details for the file fp_tools_bio-0.2.0rc15-cp313-cp313-win_amd64.whl.
File metadata
- Download URL: fp_tools_bio-0.2.0rc15-cp313-cp313-win_amd64.whl
- Upload date:
- Size: 1.7 MB
- Tags: CPython 3.13, Windows x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
baa8cb93bf4835f8cf59e6f52e594ecec2f6f5a470e9ae6f2e884b4aec427151
|
|
| MD5 |
d798d8aec43834fff8117a178767d422
|
|
| BLAKE2b-256 |
99d2a441c30a53543112dd2eb76cceb7824304219052c9d3a9f220c5393c9c76
|
File details
Details for the file fp_tools_bio-0.2.0rc15-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl.
File metadata
- Download URL: fp_tools_bio-0.2.0rc15-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
- Upload date:
- Size: 3.0 MB
- Tags: CPython 3.13, manylinux: glibc 2.17+ x86-64, manylinux: glibc 2.28+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
66c22572512074fd45a0d994f0f37a10eb3a9d6e475723dbfdfeb795a492b0ee
|
|
| MD5 |
7d3aaf0d79751f32e3190340975224c7
|
|
| BLAKE2b-256 |
4ca4095a6080acf7585f8345118d9a1edb651c0a0833001e7ffbf8e863d680c0
|
File details
Details for the file fp_tools_bio-0.2.0rc15-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl.
File metadata
- Download URL: fp_tools_bio-0.2.0rc15-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
- Upload date:
- Size: 3.0 MB
- Tags: CPython 3.13, manylinux: glibc 2.17+ ARM64, manylinux: glibc 2.28+ ARM64
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c074993ab90d8b5fd1f6e25007cc2d585359db53adb0c7bd8310f3833ab76c3e
|
|
| MD5 |
e90c2ed9e68db9714659452b192a62bf
|
|
| BLAKE2b-256 |
7f2dcc17c4f86b2cad30cdca1b3b83365f5e9f1290ecbb8c22d60866267fde2a
|
File details
Details for the file fp_tools_bio-0.2.0rc15-cp313-cp313-macosx_11_0_x86_64.whl.
File metadata
- Download URL: fp_tools_bio-0.2.0rc15-cp313-cp313-macosx_11_0_x86_64.whl
- Upload date:
- Size: 1.7 MB
- Tags: CPython 3.13, macOS 11.0+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2fcd8ea6233f8c5fb273768807ad5433a5260686153042e004c2389ea0ca8872
|
|
| MD5 |
f66bab7b9afae928d0b51365f39c0dad
|
|
| BLAKE2b-256 |
3772d7bd1dae45b6bf66a4a25ce7783213be8e6147420ee1aa0599fb10650458
|
File details
Details for the file fp_tools_bio-0.2.0rc15-cp313-cp313-macosx_11_0_arm64.whl.
File metadata
- Download URL: fp_tools_bio-0.2.0rc15-cp313-cp313-macosx_11_0_arm64.whl
- Upload date:
- Size: 1.7 MB
- Tags: CPython 3.13, macOS 11.0+ ARM64
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a9b9a0047497ead40d12a400065d82bad51aab2a7d244a669a51771416486916
|
|
| MD5 |
0f7d98182d3b57025b98404e72e4b6ea
|
|
| BLAKE2b-256 |
47498d45ce57ffb33d8d182fc8520cc1d1aff8007971adcf8e04c3b62c76af1e
|
File details
Details for the file fp_tools_bio-0.2.0rc15-cp312-cp312-win_amd64.whl.
File metadata
- Download URL: fp_tools_bio-0.2.0rc15-cp312-cp312-win_amd64.whl
- Upload date:
- Size: 1.7 MB
- Tags: CPython 3.12, Windows x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1890679fa77ce5ba4aeca84a0866855fd0e940e7f560853244c3d181f0e92cc6
|
|
| MD5 |
bcc1febde66315c62f3ec2669982d241
|
|
| BLAKE2b-256 |
e0d163068bf06168a2f18598f443ef764a9485df9ae18124779003ccee3ac4d2
|
File details
Details for the file fp_tools_bio-0.2.0rc15-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl.
File metadata
- Download URL: fp_tools_bio-0.2.0rc15-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
- Upload date:
- Size: 3.0 MB
- Tags: CPython 3.12, manylinux: glibc 2.17+ x86-64, manylinux: glibc 2.28+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e57d8ded74082642f4a1cc211bf1675333931ba5078fdd170c8d4a86a6971535
|
|
| MD5 |
e22c33addfd96a8c4453ae2d81b03d3a
|
|
| BLAKE2b-256 |
d23921a598e29c944240dedde6820727f824867f2eee2fc1c7bf6b1c68a3a8ad
|
File details
Details for the file fp_tools_bio-0.2.0rc15-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl.
File metadata
- Download URL: fp_tools_bio-0.2.0rc15-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
- Upload date:
- Size: 3.0 MB
- Tags: CPython 3.12, manylinux: glibc 2.17+ ARM64, manylinux: glibc 2.28+ ARM64
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4dc8a5efc5162b0816edcb6b1548797a9915e1b68832842b86f6ef5d7aafe2da
|
|
| MD5 |
6316dc78bf8377c6ecab9a3c0525daa8
|
|
| BLAKE2b-256 |
e8e8e2722fdce8279a748ca162224930209b2cb0c33f89a08ffa1624b90cee38
|
File details
Details for the file fp_tools_bio-0.2.0rc15-cp312-cp312-macosx_11_0_x86_64.whl.
File metadata
- Download URL: fp_tools_bio-0.2.0rc15-cp312-cp312-macosx_11_0_x86_64.whl
- Upload date:
- Size: 1.7 MB
- Tags: CPython 3.12, macOS 11.0+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e5158cd2a297d23481184bc6cce6e5926fdeb56127315340362f38bd2ad83578
|
|
| MD5 |
3981ebf9f88d809e0345ebf789431c91
|
|
| BLAKE2b-256 |
c5568cf2c85fafccc3292f980405a771ceca9cc15d982655022e202c1cfbadfd
|
File details
Details for the file fp_tools_bio-0.2.0rc15-cp312-cp312-macosx_11_0_arm64.whl.
File metadata
- Download URL: fp_tools_bio-0.2.0rc15-cp312-cp312-macosx_11_0_arm64.whl
- Upload date:
- Size: 1.7 MB
- Tags: CPython 3.12, macOS 11.0+ ARM64
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e3aa7a2854ab9163f32cb04885e80673de9b7e535795519b9c27e23b91f07b00
|
|
| MD5 |
4f0732822e74ea76ffb22f9e3048c7f4
|
|
| BLAKE2b-256 |
7831f9eaf4228efcb19f121349c92ac23e9a375083a10cfb69f501e00e31a2c0
|
File details
Details for the file fp_tools_bio-0.2.0rc15-cp311-cp311-win_amd64.whl.
File metadata
- Download URL: fp_tools_bio-0.2.0rc15-cp311-cp311-win_amd64.whl
- Upload date:
- Size: 1.7 MB
- Tags: CPython 3.11, Windows x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
942883cfe17081a4e6862db0081b42d612dada8b099aa7a22ff4ddb28ac6ac38
|
|
| MD5 |
0fc96204bc8c24a188c577434adc8bd1
|
|
| BLAKE2b-256 |
9df718339a3de73a94cee509b6ba19a0bebb8349c7762a2eae02707d8f6f11f1
|
File details
Details for the file fp_tools_bio-0.2.0rc15-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl.
File metadata
- Download URL: fp_tools_bio-0.2.0rc15-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
- Upload date:
- Size: 3.0 MB
- Tags: CPython 3.11, manylinux: glibc 2.17+ x86-64, manylinux: glibc 2.28+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ce8fcdcf8add8b83e930439085aac0e24a1f895c542c460147d45c2f4f134193
|
|
| MD5 |
34a33116fcf599058578bc06c258a409
|
|
| BLAKE2b-256 |
55909c6f3fc19f6b8071d454c2dce80bff0ddcc2331131b4f3262e7536a09f45
|
File details
Details for the file fp_tools_bio-0.2.0rc15-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl.
File metadata
- Download URL: fp_tools_bio-0.2.0rc15-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
- Upload date:
- Size: 3.0 MB
- Tags: CPython 3.11, manylinux: glibc 2.17+ ARM64, manylinux: glibc 2.28+ ARM64
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
828eaf75e924b92ae51225999090360a777cde27be8f6a43f232648f72152f0e
|
|
| MD5 |
757be6beb62fadd6b5e5a5a6027355bd
|
|
| BLAKE2b-256 |
779cfd929e7a443cd027945390ff1f1b473de4640c38cd67c3833841d0735415
|
File details
Details for the file fp_tools_bio-0.2.0rc15-cp311-cp311-macosx_11_0_x86_64.whl.
File metadata
- Download URL: fp_tools_bio-0.2.0rc15-cp311-cp311-macosx_11_0_x86_64.whl
- Upload date:
- Size: 1.7 MB
- Tags: CPython 3.11, macOS 11.0+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ba6d023083d5c8f18c22b7012a57cd42326bdf29dba67f66c5a1034000a36cf6
|
|
| MD5 |
ae62447f9e31ca5c4a0bc93062a6e110
|
|
| BLAKE2b-256 |
44bf9f82a3f2ad56143d541418b785887a104b5bce64b5dbda068dd60895c437
|
File details
Details for the file fp_tools_bio-0.2.0rc15-cp311-cp311-macosx_11_0_arm64.whl.
File metadata
- Download URL: fp_tools_bio-0.2.0rc15-cp311-cp311-macosx_11_0_arm64.whl
- Upload date:
- Size: 1.7 MB
- Tags: CPython 3.11, macOS 11.0+ ARM64
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3936350bd41402f37b436594a408408ed63fc2198cd05fa7be32045be510daad
|
|
| MD5 |
622d08c2575d87d2596314555020f2e3
|
|
| BLAKE2b-256 |
45232f60dc6896dec5fdbfc0bef5fb432a3838a019f06577ebf6499116c64045
|