Skip to content

Commit

Permalink
Merge pull request #117 from phac-nml/doc/installation
Browse files Browse the repository at this point in the history
Doc/installation
  • Loading branch information
Takadonet authored Feb 22, 2020
2 parents 820191c + 1a3937b commit 80173a4
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
1 change: 1 addition & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ install:
- conda info -a
- conda create -c bioconda -c conda-forge -q -y -n test-environment python=$TRAVIS_PYTHON_VERSION blast=2.7.1 git mlst
- source activate test-environment
- pip install pandas==0.25.3
- python setup.py install
- staramr db build --dir staramr/databases/data $DATABASE_COMMITS
- pip install mypy==0.600
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,10 +159,10 @@ staramr db restore-default
The easiest way to install `staramr` is through [Bioconda][bioconda].

```bash
conda install -c bioconda staramr
conda install -c bioconda staramr==0.7.1
```

This will install the `staramr` Python package as well as all necessary dependencies and databases. You can now run:
This will install the `staramr` Python package at version `0.7.1` (replace with whichever version you wish to install). Bioconda will install all necessary dependencies and databases. Once this is complete you can run:

```bash
staramr --help
Expand All @@ -171,7 +171,7 @@ staramr --help
If you wish to use `staramr` in an isolated environment (in case dependencies conflict) you may alternatively install with:

```bash
conda create -c bioconda --name staramr staramr
conda create -c bioconda --name staramr staramr==0.7.1
```

To run `staramr` in this case, you must first activate the environment. That is:
Expand Down

0 comments on commit 80173a4

Please sign in to comment.