Skip to content

Commit b1583b5

Browse files
committed
Updated install instructions after testing
1 parent 62b7994 commit b1583b5

File tree

1 file changed

+17
-33
lines changed

1 file changed

+17
-33
lines changed

README.md

Lines changed: 17 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,23 @@ StxTyper is used to determine stx type from nucleotide sequence. Stx (Shiga-toxi
66

77
# Installation
88

9+
## Installing with Bioconda
10+
11+
You'll need Mamba ([Installation instructions](https://mamba.readthedocs.io/en/latest/installation/micromamba-installation.html)) first.
12+
13+
micromamba create -n stxtyper ncbi-stxtyper \
14+
--channel conda-forge \
15+
--channel bioconda \
16+
--channel defaults \
17+
--strict-channel-priority
18+
919
## Installing from binary
1020

1121
### Prerequisites
1222

1323
#### NCBI BLAST+
1424

15-
See below under "Compiling" for instructions to install.
25+
See below under "Compiling" for instructions to install NCBI BLAST+.
1626

1727
### Download and install Binary
1828

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

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

27-
## Installing with Bioconda
28-
29-
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.
30-
31-
conda create -n stxtyper ncbi-stxtyper \
32-
--channel conda-forge \
33-
--channel bioconda \
34-
--channel defaults \
35-
--strict-channel-priority
36-
37-
or
38-
39-
micromamba create -n stxtyper ncbi-stxtyper \
40-
--channel conda-forge \
41-
--channel bioconda \
42-
--channel defaults \
43-
--strict-channel-priority
44-
4537
## Compiling
4638

4739
### Prerequisites
4840

4941
#### NCBI BLAST+
5042

51-
StxTyper needs NCBI BLAST binaries in your path (specifically tblastn). If you don't
52-
already have BLAST installed see https://www.ncbi.nlm.nih.gov/books/NBK569861/
53-
for instructions to install BLAST binaries.
54-
55-
Blast can also be installed using bioconda by first installing bioconda, then making sure to activate the environment in which it's installed.
56-
- See the [official install miniconda instructions for Linux](https://docs.anaconda.com/free/miniconda/#quick-command-line-install)
57-
- See the [official install miniconda instructions for MacOS](https://docs.conda.io/en/latest/miniconda.html)
58-
59-
Then run:
60-
61-
source ~/miniconda3/bin/activate
62-
conda create -y -c conda-forge -c bioconda -n blast blast
63-
conda activate blast
43+
StxTyper needs NCBI BLAST binaries in your path (specifically tblastn). If you
44+
don't already have BLAST installed see
45+
https://www.ncbi.nlm.nih.gov/books/NBK569861/ for the official instructions to
46+
install BLAST binaries. It's also available in many package repositories, for
47+
example on Ubuntu:
6448

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

6751
#### C compiler and make
6852

0 commit comments

Comments
 (0)