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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: deciphon-0.11.13.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.13.tar.gz
Algorithm Hash digest
SHA256 bc6dc071416860ee53e250f266697c65971b7bb31057605ebbf443530a534ddf
MD5 16800243ac9df875a491d7ffb8ae639e
BLAKE2b-256 63ba7938f7559571e33f7606a177e13bd5b56a54fa2430e91219e8529cdaf036

See more details on using hashes here.

File details

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

File metadata

  • Download URL: deciphon-0.11.13-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.13-py3-none-any.whl
Algorithm Hash digest
SHA256 63e587dbdd64d42c25472852617cd22ad84653fc07a0a1907f382f986cc1c3e1
MD5 5ed6a65aa24e6b1c16ffea4287fd6de6
BLAKE2b-256 3d024ac3f8a65d3f2d477f64a7613ba3aec91229e4689895be0fba0727e50212

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