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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: deciphon-0.13.5.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.13.5.tar.gz
Algorithm Hash digest
SHA256 290478b8824982f6e14ff4cf643b8dd6e0a750ba77959058b1099635b1c4538e
MD5 ffb308bc7bf8e740ff9792394fe53b77
BLAKE2b-256 2a373d0b7cad9fdc39f637a66ef1827b7f0bafb64d6acd1c655f80ac2cfb6621

See more details on using hashes here.

File details

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

File metadata

  • Download URL: deciphon-0.13.5-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.13.5-py3-none-any.whl
Algorithm Hash digest
SHA256 9b16883d67ca51f4705b1c5c94284cf723cb076eee15b273d4a4cfd1cc5d1d6b
MD5 013c8a2306d37c52a82ba86368d6e6b4
BLAKE2b-256 60e5a92fa969559105e9c9c9e7655ddaa1effdf142c064c9a8605db69a0e862b

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