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

Uploaded Source

Built Distribution

deciphon-0.11.3-py3-none-any.whl (9.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: deciphon-0.11.3.tar.gz
  • Upload date:
  • Size: 7.1 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.3.tar.gz
Algorithm Hash digest
SHA256 fbe1e17a589dc9348d5eaaf3285bdaddccd07e3036a46af36aeaeed0e7850a87
MD5 971149c9d8d7f52124f8aaae51aaf69f
BLAKE2b-256 4c4b36633a2f618dd041d0d247c0802562276534c602dc88845d56572a0c5b86

See more details on using hashes here.

File details

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

File metadata

  • Download URL: deciphon-0.11.3-py3-none-any.whl
  • Upload date:
  • Size: 9.3 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 22bee2d7bcdfbf24ad0e7819e2de21e1bbdfad1098e8c0dbaf1cf966e9eb5e43
MD5 c81de93ddeefaa01b82b1495ac1bd2e0
BLAKE2b-256 826a9f7e3d4ae9b4fd5e59d777c351d638752a62ca5a676767f992478dd240e0

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