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.11.16.tar.gz (7.2 kB view details)

Uploaded Source

Built Distribution

deciphon-0.11.16-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: deciphon-0.11.16.tar.gz
  • Upload date:
  • Size: 7.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for deciphon-0.11.16.tar.gz
Algorithm Hash digest
SHA256 60a595b63eb92e097b2dcef12870dc66002d612cab8fc443f6d7a87f19da15b6
MD5 c48d3b00999d298ed64371ae75102ddd
BLAKE2b-256 50a873943f41f3b06b266c0dfae6d9b75eea0a251434224755874564a3dabb0e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: deciphon-0.11.16-py3-none-any.whl
  • Upload date:
  • Size: 9.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for deciphon-0.11.16-py3-none-any.whl
Algorithm Hash digest
SHA256 5e0e7f443b2635dafd605c8b60dc8895ec98a9dd1de9d09d5d2a70bfa1407a1b
MD5 ba1d36c6d3f44f109fb10393115f364c
BLAKE2b-256 6a6b456e291711c3cba20e35c8cc0d197a95a9afc8ef1bad1cf57bb4a7517a37

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