Skip to main content

Individually annotate long, error-prone nucleotide sequences into proteins

Project description

Welcome to deciphon ๐Ÿ‘‹

Individually annotate long, error-prone nucleotide sequences into proteins

๐Ÿ  Homepage

โšก๏ธ Requirements

  • Python >= 3.9
  • Pip
  • Podman >= 3.4
  • Homebrew on MacOS (recommended)
  • Pipx for Python package management (recommended)

MacOS

Install Python and Podman:

brew update && brew install python podman pipx

Ensure that your PATH environment variable is all set:

pipx ensurepath

๐Ÿ’ก You might need to close your terminal and reopen it for the changes to take effect.

Ubuntu (and Debian-based distros)

Install Python and Podman:

sudo apt update && \
    sudo apt install python3 python3-pip python3-venv podman --yes && \
    python3 -m pip install --user pipx

Ensure that your PATH environment variable is all set:

python3 -m pipx ensurepath

๐Ÿ’ก You might need to close your terminal and reopen it for the changes to take effect.

Install

pipx install deciphon

Usage

 Usage: deci [OPTIONS] COMMAND [ARGS]...

โ•ญโ”€ Options โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
โ”‚ --version                                                                    โ”‚
โ”‚ --help             Show this message and exit.                               โ”‚
โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ
โ•ญโ”€ Commands โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
โ”‚ press        Press HMM ASCII file into a Deciphon database one.              โ”‚
โ”‚ scan         Annotate nucleotide sequences into proteins a protein database. โ”‚
โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ

Example

Download the minifam.hmm protein database:

curl -O https://raw.githubusercontent.com/EBI-Metagenomics/deciphon/main/cli/tests/files/minifam.hmm

Download the consensus.fna file of sequences:

curl -O https://raw.githubusercontent.com/EBI-Metagenomics/deciphon/main/cli/tests/files/sequences.fna

Press it (using The Standard Code):

deci press minifam.hmm 1

Scan it:

deci scan minifam.hmm sequences.fna

Show it:

deci see sequences.dcs

๐Ÿ‘ค Author

Show your support

Give a โญ๏ธ if this project helped you!

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

deciphon-0.14.0.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

deciphon-0.14.0-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

Details for the file deciphon-0.14.0.tar.gz.

File metadata

  • Download URL: deciphon-0.14.0.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for deciphon-0.14.0.tar.gz
Algorithm Hash digest
SHA256 bad3b7d2342cfd1161b83597f52605a22a37f46e99c99195110d7a87b42c0bb3
MD5 3c3c69b4ff07e127d8d884863fb17b03
BLAKE2b-256 e89ec05039def5a7e194da2c4a496670d65657b0c7b258a7a825e6a9dd6cc4d9

See more details on using hashes here.

File details

Details for the file deciphon-0.14.0-py3-none-any.whl.

File metadata

  • Download URL: deciphon-0.14.0-py3-none-any.whl
  • Upload date:
  • Size: 9.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for deciphon-0.14.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fd535e38d516db4ea73cdda4d53114af6b103ca4fcbca94f93a8d6d071c1e341
MD5 ea805e24bb3ff74f6473bc792680572d
BLAKE2b-256 519ef557676311d93c84efe275a2307efd5ed735874a8764be95406bb8be5c39

See more details on using hashes here.

Supported by

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