Crunchy
A python wrapper around spring and cram (samtools) to compress fastq to spring and bam to cram. When compressing fastqs to spring an integrity check can be performed by using flag: crunchy compress spring --spring-path <springfile> --first <read_1.fastq> --second <read_2.fastq> --check-integrity
Install
Pip
pip install crunchy
Docker
This will install crunchy as well as samtools and spring within the container.
docker pull clinicalgenomics/crunchy:0.5
Run crunchy using:
docker run clinicalgenomics/crunchy:0.5 crunchy
Developers
git clone https://github.com/Clinical-Genomics/crunchy
pip install -e .
crunchy --help
Usage: crunchy [OPTIONS] COMMAND [ARGS]...
Base command for crunchy
.---. .---.
: : o : me want cookie!
_..-: o : :-.._ /
.-'' ' `---' `---' " ``-.
.' " ' " . " . ' " `.
: '.---.,,.,...,.,.,.,..---. ' ;
`. " `. .' " .'
`. '`. .' ' .'
`. `-._ _.-' " .' .----.
`. " '"--...--"' . ' .' .' o `.
.'`-._' " . " _.-'`. : o :
.' ```--.....--''' ' `:_ o :
.' " ' " " ; `.;";";";'
; ' " ' . ; .' ; ; ;
; ' ' ' " .' .-'
' " " ' " " _.-'
Options:
--spring-binary TEXT Path to spring binary [default: spring]
--samtools-binary TEXT Path to spring binary [default: samtools]
-t, --threads INTEGER Number of threads to use for spring
compression [default: 8]
-r, --reference TEXT Path to reference genome
--log-level [DEBUG|INFO|WARNING]
Choose what log messages to show
--tmp-dir TEXT If specific temp dir should be used
--help Show this message and exit.
Commands:
auto Run whole pipeline by compressing, comparing and deleting...
compare Compare two files by generating checksums.
compress Compress genomic files
decompress Decompress genomic files
Workflow
Each command can be run separately. To compress all fastq pairs below a directory run crunchy auto spring <path_to_dir>.
-
Recursively find all fastq pairs
-
Compress all pairs with spring
file_1.fastq + file_2.fastq (spring)-> file.spring -
Decompress with spring
file.spring (spring)-> file_1.spring.fastq + file_2.spring.fastq -
Compare checksum with previous
file_1.spring.fastq + file_1.fastq (hashlib)-> compare -
Delete fastq (If the compression was lossless)
file_1.fastq + file_2.fastq (rm)->
Metadata
Release files for crunchy 1.0.13
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| crunchy-1.0.13.tar.gz | 3.0 MB | Without provenance | Details for crunchy-1.0.13.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| crunchy-1.0.13-py3-none-any.whl | Python 3 | none | any | Details for crunchy-1.0.13-py3-none-any.whl |
Total release size: 6.1 MB
Release files / crunchy-1.0.13.tar.gz
| Download URL | crunchy-1.0.13.tar.gz |
|---|---|
| Size | 3.0 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
15e09db5358feb0714679f59f4a2541866fc36e52a786e52ff7e681c74321eb1
|
|
BLAKE2b-256 checksum How to use checksums |
22f97dadef6a0c7f65f434216cc4b163235e0d29e341693172c02426fd4cb7ea
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.5 CPython/3.12.7 Linux/6.5.0-1025-azure
|
Release files / crunchy-1.0.13-py3-none-any.whl
| Download URL | crunchy-1.0.13-py3-none-any.whl |
|---|---|
| Size | 3.1 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1400632d003266b6c0d0eae381dd6b7eac9a3787ca6abe32f1c1a2b4dbf38bf7
|
|
BLAKE2b-256 checksum How to use checksums |
fd325da611dee9d61cf3782dc8d61068b251de3c22d562e23558196ece3b3809
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.5 CPython/3.12.7 Linux/6.5.0-1025-azure
|
Security for crunchy 1.0.13
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.