Skip to main content

CLI for DeepChopper: A Genomic Language Model for Chimera Artifact Detection

Project description

logo DeepChopper social

pypi PyPI - Wheel license pypi version platform Actions status Space

🧬 DeepChopper leverages a language model to accurately detect and chop artificial sequences that may cause chimeric reads, ensuring higher quality and more reliable sequencing results. By integrating seamlessly with existing workflows, DeepChopper provides a robust solution for researchers and bioinformaticians working with Nanopore direct-RNA sequencing data.

✨ What's New in v1.3.0

  • 🚀 Direct FASTQ Processing: No more encoding step! DeepChopper now works directly with FASTQ files
  • ⚡ Simplified Workflow: Go from raw data to results in just 2 commands (predictchop)
  • 📦 Auto-format Detection: Automatically handles .fastq, .fq, .fastq.gz, and .fq.gz files
  • ⚠️ Breaking Change: The encode command has been removed - update your pipelines accordingly

See full changelog →

📘 FEATURED: We provide a comprehensive tutorial that includes an example dataset in our full documentation.

🚀 Quick Start: Try DeepChopper Online

Experience DeepChopper instantly through our user-friendly web interface. No installation required! Simply click the button below to launch the web application and start exploring DeepChopper's capabilities:

Open in Hugging Face Spaces

What you can do online:

  • 📤 Upload your sequencing data
  • 🔬 Run DeepChopper's analysis
  • 📊 Visualize results
  • 🎛️ Experiment with different parameters

Perfect for quick tests or demonstrations! However, for extensive analyses or custom workflows, we recommend installing DeepChopper locally.

⚠️ Note: The online version is limited to one FASTQ record at a time and may not be suitable for large-scale projects.

📦 Installation

DeepChopper can be installed using pip, the Python package installer. Follow these steps to install:

  1. Ensure you have Python 3.10 or later installed on your system.

  2. Create a virtual environment (recommended):

    python -m venv deepchopper_env
    source deepchopper_env/bin/activate  # On Windows use `deepchopper_env\Scripts\activate`
    
  3. Install DeepChopper:

    pip install deepchopper
    
  4. Verify the installation:

    deepchopper --help
    

Compatibility and Support

DeepChopper is designed to work across various platforms and Python versions. Below are the compatibility matrices for PyPI installations:

PyPI Support

Python Version Linux x86_64 macOS Intel macOS Apple Silicon Windows x86_64
3.10
3.11
3.12

🆘 Trouble installing? Check our Troubleshooting Guide or open an issue.

🛠️ Usage

For a comprehensive guide, check out our full tutorial. Here's a quick overview:

Command-Line Interface

🎉 New in v1.3.0: DeepChopper now works directly with FASTQ files! No encoding step required.

DeepChopper offers two main commands: predict and chop.

  1. Predict chimera artifacts directly from FASTQ:

    deepchopper predict input.fastq --output predictions
    

    Using GPUs? Add the --gpus flag:

    deepchopper predict input.fastq --output predictions --gpus 2
    

    Supports all FASTQ formats: .fastq, .fq, .fastq.gz, .fq.gz

  2. Chop chimera artifacts:

    deepchopper chop predictions/0 input.fastq
    

Want a GUI? Launch the web interface (note: limited to one FASTQ record at a time):

deepchopper web

Python Library

Integrate DeepChopper into your Python scripts:

import deepchopper

model = deepchopper.DeepChopper.from_pretrained("yangliz5/deepchopper")
# Your analysis code here

📚 Cite

If DeepChopper aids your research, please cite our paper:

@article{li2026genomic,
  title = {Genomic Language Model Mitigates Chimera Artifacts in Nanopore Direct {{RNA}} Sequencing},
  author = {Li, Yangyang and Wang, Ting-You and Guo, Qingxiang and Ren, Yanan and Lu, Xiaotong and Cao, Qi and Yang, Rendong},
  date = {2026-01-19},
  journaltitle = {Nature Communications},
  shortjournal = {Nat Commun},
  publisher = {Nature Publishing Group},
  issn = {2041-1723},
  doi = {10.1038/s41467-026-68571-5},
  url = {https://www.nature.com/articles/s41467-026-68571-5},
  urldate = {2026-01-20}
}

🤝 Contribution

We welcome contributions! Here's how to set up your development environment:

Build Environment

Install UV and Rust

git clone https://github.com/ylab-hi/DeepChopper.git
cd DeepChopper

# Install dependencies
uv sync

# Run DeepChopper
uv run deepchopper --help

🎉 Ready to contribute? Check out our Contribution Guidelines to get started!

🔗 Related Projects

  • ChimeraLM - Identify artificial chimeric reads from whole genome amplification (WGA) processes

📬 Support

Need help? Have questions?


DeepChopper is developed with ❤️ by the YLab team. Happy sequencing! 🧬🔬

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

deepchopper_cli-1.3.3.tar.gz (58.8 MB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

deepchopper_cli-1.3.3-cp312-cp312-win_amd64.whl (1.8 MB view details)

Uploaded CPython 3.12Windows x86-64

deepchopper_cli-1.3.3-cp312-cp312-musllinux_1_2_x86_64.whl (2.2 MB view details)

Uploaded CPython 3.12musllinux: musl 1.2+ x86-64

deepchopper_cli-1.3.3-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (2.4 MB view details)

Uploaded CPython 3.12manylinux: glibc 2.17+ x86-64

deepchopper_cli-1.3.3-cp312-cp312-macosx_11_0_arm64.whl (1.8 MB view details)

Uploaded CPython 3.12macOS 11.0+ ARM64

deepchopper_cli-1.3.3-cp312-cp312-macosx_10_12_x86_64.whl (1.9 MB view details)

Uploaded CPython 3.12macOS 10.12+ x86-64

deepchopper_cli-1.3.3-cp311-cp311-win_amd64.whl (1.8 MB view details)

Uploaded CPython 3.11Windows x86-64

deepchopper_cli-1.3.3-cp311-cp311-musllinux_1_2_x86_64.whl (2.2 MB view details)

Uploaded CPython 3.11musllinux: musl 1.2+ x86-64

deepchopper_cli-1.3.3-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (2.4 MB view details)

Uploaded CPython 3.11manylinux: glibc 2.17+ x86-64

deepchopper_cli-1.3.3-cp311-cp311-macosx_11_0_arm64.whl (1.8 MB view details)

Uploaded CPython 3.11macOS 11.0+ ARM64

deepchopper_cli-1.3.3-cp311-cp311-macosx_10_12_x86_64.whl (1.9 MB view details)

Uploaded CPython 3.11macOS 10.12+ x86-64

deepchopper_cli-1.3.3-cp310-cp310-win_amd64.whl (1.8 MB view details)

Uploaded CPython 3.10Windows x86-64

deepchopper_cli-1.3.3-cp310-cp310-musllinux_1_2_x86_64.whl (2.2 MB view details)

Uploaded CPython 3.10musllinux: musl 1.2+ x86-64

deepchopper_cli-1.3.3-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (2.4 MB view details)

Uploaded CPython 3.10manylinux: glibc 2.17+ x86-64

deepchopper_cli-1.3.3-cp310-cp310-macosx_11_0_arm64.whl (1.8 MB view details)

Uploaded CPython 3.10macOS 11.0+ ARM64

deepchopper_cli-1.3.3-cp310-cp310-macosx_10_12_x86_64.whl (1.9 MB view details)

Uploaded CPython 3.10macOS 10.12+ x86-64

File details

Details for the file deepchopper_cli-1.3.3.tar.gz.

File metadata

  • Download URL: deepchopper_cli-1.3.3.tar.gz
  • Upload date:
  • Size: 58.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: maturin/1.13.1

File hashes

Hashes for deepchopper_cli-1.3.3.tar.gz
Algorithm Hash digest
SHA256 7a4b49b55ae22d3c8335374e6c0d7e41db84e797f22abf88f26b274509fb7304
MD5 e0c2adb6f081390965ef8d76115944b1
BLAKE2b-256 4944cc492520fd90c4c4ec0e2042b8cfac7bc641ea8f08b9b4f240aa37b99f56

See more details on using hashes here.

File details

Details for the file deepchopper_cli-1.3.3-cp312-cp312-win_amd64.whl.

File metadata

File hashes

Hashes for deepchopper_cli-1.3.3-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 090abad0153d4537ebb57387eeb637464a48f9ccd71824b831f24ef15fa4d678
MD5 b3b775220f74dd48b4ef227d9e092871
BLAKE2b-256 181a10f699632d122c2960bdd403c7046d6ec617c6e4988ce6064a937c812c15

See more details on using hashes here.

File details

Details for the file deepchopper_cli-1.3.3-cp312-cp312-musllinux_1_2_x86_64.whl.

File metadata

File hashes

Hashes for deepchopper_cli-1.3.3-cp312-cp312-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 2548488760fa72e528ddb01a6f79eb0e08fef13b384529acdc45b0e96f74a03a
MD5 624a9a83009c50e65aba8205c1cf144c
BLAKE2b-256 8cb6daf4f5ea31f1eec3e11cd8b877f445dcf52b86c0cebe9f57296f7deaa993

See more details on using hashes here.

File details

Details for the file deepchopper_cli-1.3.3-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for deepchopper_cli-1.3.3-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 5dbb469764b660ba4dffbe9013f964266d077a1f94cd01a0a901412a3a1c46e7
MD5 15f10e00deae51280d789b106438bd53
BLAKE2b-256 8756b6bcd4aeefff6b4ea7872f23f2b741e547b572e510e671a8a44bbe657b4e

See more details on using hashes here.

File details

Details for the file deepchopper_cli-1.3.3-cp312-cp312-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for deepchopper_cli-1.3.3-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 dab396b4351199d3446a62149ea3df4eff0f2deaa29b5065283bbc59214f6dc7
MD5 bf652089ad0175b29c07c21251ee8865
BLAKE2b-256 5ac30d17eb4cefe8fb4d9cea1d48a965053b5c07da76dbb0f963acbf99af6899

See more details on using hashes here.

File details

Details for the file deepchopper_cli-1.3.3-cp312-cp312-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for deepchopper_cli-1.3.3-cp312-cp312-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 677070456c70d75ba81b22e3806783bd2bbf9b6ac5b1257dbec5ea592a18b76f
MD5 5ff3f98c21d9e5975ba2fa6f105ac828
BLAKE2b-256 8cc1955124e14d736a6306d7bbc7f45272f91a689d0e9de53f55288bdb40afb9

See more details on using hashes here.

File details

Details for the file deepchopper_cli-1.3.3-cp311-cp311-win_amd64.whl.

File metadata

File hashes

Hashes for deepchopper_cli-1.3.3-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 3bc2ca838d1a82f67918087ba5eb8745d7eb1ff6430559d20f63711952b079e7
MD5 1a6cfd8f62c5b4648a9a67e15ebcc94d
BLAKE2b-256 a3a23102b343f7cc4a449055dcc0f25cc45a6690ff1829549ca5fd166428509e

See more details on using hashes here.

File details

Details for the file deepchopper_cli-1.3.3-cp311-cp311-musllinux_1_2_x86_64.whl.

File metadata

File hashes

Hashes for deepchopper_cli-1.3.3-cp311-cp311-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 2316902ca4747539db530dcaafad898fa63c18e7dd3d8527d0e32a9ec5d2f635
MD5 6dd09bb15210da1669767c4277f2811e
BLAKE2b-256 60cd14e677db18d381e7bf03f96921517d992992016faed109a4ecdfc0c57096

See more details on using hashes here.

File details

Details for the file deepchopper_cli-1.3.3-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for deepchopper_cli-1.3.3-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 36456ade2be7d705cf017b59f03da3a628502a8f57c1f37a96a2267ad58c8861
MD5 8507bd0d3272ad12d4dfd3f22e6a384b
BLAKE2b-256 1cb5aacd7a96fa79e9bfee64d754ba85f3146c7ebcb622ffbb13c6511798208e

See more details on using hashes here.

File details

Details for the file deepchopper_cli-1.3.3-cp311-cp311-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for deepchopper_cli-1.3.3-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 00667c406892931bc07ba33ba948bc45d1046cd8aa1b505853be37d0c876173c
MD5 b1d7018312f077447876714a6fea778f
BLAKE2b-256 3b542a58428e2930996a1b330c371d9c87548b3b17f3c3b333b45f22b53458a9

See more details on using hashes here.

File details

Details for the file deepchopper_cli-1.3.3-cp311-cp311-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for deepchopper_cli-1.3.3-cp311-cp311-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 68f79bdbc2f3e5b1f7bf5717e04a22d719daa70a1e161548702d9da671cbc0e9
MD5 9fd03955919bf021330eaa6383e3a230
BLAKE2b-256 c548a59a26b215ba8abeb4103c96628c5eec0b9dc6c032165dcc34aa81945d73

See more details on using hashes here.

File details

Details for the file deepchopper_cli-1.3.3-cp310-cp310-win_amd64.whl.

File metadata

File hashes

Hashes for deepchopper_cli-1.3.3-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 00d693cb70d1cf22fb91d9e28b54c7961b8f4ece32716b0c60a08c24b9c02977
MD5 c4d7ed08b04f2535925cfa517d4028e5
BLAKE2b-256 b3d093c5df24acc9b3e2b52b3eaf7161815535d1dd92afee8c9603a45223c988

See more details on using hashes here.

File details

Details for the file deepchopper_cli-1.3.3-cp310-cp310-musllinux_1_2_x86_64.whl.

File metadata

File hashes

Hashes for deepchopper_cli-1.3.3-cp310-cp310-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 a10bdbbbb52cb64552276bbd02c1aa4a0ca95295923e498246d1e4a0fc5fda27
MD5 571946626a3e708ef4d2fdce3c23eae4
BLAKE2b-256 f7980d4b441aa796fc1295b17bc48f7ae679d69bf7e386a7c8bcfcbeaf0d142f

See more details on using hashes here.

File details

Details for the file deepchopper_cli-1.3.3-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for deepchopper_cli-1.3.3-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 51cf5f35c635e4a2682f9cf0ab9894ad28e768bdef6274299c1903dddbec7a3c
MD5 a9deabf1675d65fcd5fa8c18bac24d7e
BLAKE2b-256 a90627cbca3f8220cfcee74d0d5d3727bec1c39cb0daea8d951ecb26515b3453

See more details on using hashes here.

File details

Details for the file deepchopper_cli-1.3.3-cp310-cp310-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for deepchopper_cli-1.3.3-cp310-cp310-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 4318d6bed24f1bd2b1c7e06502fd772c1b6249a3b678179dd370bbecd1e04850
MD5 d2855eabac5784aed42a73c25536fa53
BLAKE2b-256 b28a4e67d34c1afdffeaf1088557ae6f2fa767da6e2e10ada7c97acedbd5c3ee

See more details on using hashes here.

File details

Details for the file deepchopper_cli-1.3.3-cp310-cp310-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for deepchopper_cli-1.3.3-cp310-cp310-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 d15840cb9a28425549668568b054225fe665d7ee96e6151ca97f5b3c8ed79421
MD5 950b0f4bdc7a1fd6aabc55381d6d0f98
BLAKE2b-256 c3c73cb7b35ef1eb6b5e7f757b41d362fd65a1d995be090cfc81f7fd3b838cf3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page