Skip to content

Commit

Permalink
Updated install instructions after testing
Browse files Browse the repository at this point in the history
  • Loading branch information
evolarjun committed Aug 9, 2024
1 parent 62b7994 commit b1583b5
Showing 1 changed file with 17 additions and 33 deletions.
50 changes: 17 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,23 @@ StxTyper is used to determine stx type from nucleotide sequence. Stx (Shiga-toxi

# Installation

## Installing with Bioconda

You'll need Mamba ([Installation instructions](https://mamba.readthedocs.io/en/latest/installation/micromamba-installation.html)) first.

micromamba create -n stxtyper ncbi-stxtyper \
--channel conda-forge \
--channel bioconda \
--channel defaults \
--strict-channel-priority

## Installing from binary

### Prerequisites

#### NCBI BLAST+

See below under "Compiling" for instructions to install.
See below under "Compiling" for instructions to install NCBI BLAST+.

### Download and install Binary

Expand All @@ -24,45 +34,19 @@ Download the latest binary tarball from https://github.com/ncbi/stxtyper/release

Note that we are currently only publishing binary tarballs for x86 linux.

## Installing with Bioconda

You'll need Mamba ([Installation instructions](https://mamba.readthedocs.io/en/latest/installation/micromamba-installation.html)) or Conda ([Installation instructions](https://docs.anaconda.com/miniconda/miniconda-install/)) first.

conda create -n stxtyper ncbi-stxtyper \
--channel conda-forge \
--channel bioconda \
--channel defaults \
--strict-channel-priority

or

micromamba create -n stxtyper ncbi-stxtyper \
--channel conda-forge \
--channel bioconda \
--channel defaults \
--strict-channel-priority

## Compiling

### Prerequisites

#### NCBI BLAST+

StxTyper needs NCBI BLAST binaries in your path (specifically tblastn). If you don't
already have BLAST installed see https://www.ncbi.nlm.nih.gov/books/NBK569861/
for instructions to install BLAST binaries.

Blast can also be installed using bioconda by first installing bioconda, then making sure to activate the environment in which it's installed.
- See the [official install miniconda instructions for Linux](https://docs.anaconda.com/free/miniconda/#quick-command-line-install)
- See the [official install miniconda instructions for MacOS](https://docs.conda.io/en/latest/miniconda.html)

Then run:

source ~/miniconda3/bin/activate
conda create -y -c conda-forge -c bioconda -n blast blast
conda activate blast
StxTyper needs NCBI BLAST binaries in your path (specifically tblastn). If you
don't already have BLAST installed see
https://www.ncbi.nlm.nih.gov/books/NBK569861/ for the official instructions to
install BLAST binaries. It's also available in many package repositories, for
example on Ubuntu:

If you install BLAST via conda in this way you will need to run `conda activate blast` before you can run StxTyper.
sudo apt-get install ncbi-blast+

#### C compiler and make

Expand Down

0 comments on commit b1583b5

Please sign in to comment.