Skip to content

Commit

Permalink
Merge pull request #604 from nextstrain/document-conda-support
Browse files Browse the repository at this point in the history
Document conda support
  • Loading branch information
huddlej authored Aug 17, 2020
2 parents 8e9c926 + 3752ba3 commit bbad9a5
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 14 deletions.
13 changes: 12 additions & 1 deletion DEV_DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ Thank you for helping us to improve Nextstrain! This document describes:
- Contributing code
- Running local code changes
- Testing
- Creating a release
- Releasing
- Maintaining Bioconda package
- Continuous integration
- Contributing documentation
- Formats (Markdown and reStructuredText)
Expand Down Expand Up @@ -170,6 +171,16 @@ If any tests fail, run the `./devel/rewind-release` script to undo the release,
[a PyPi account]: https://pypi.org/account/register/
[twine]: https://pypi.org/project/twine

### Maintaining Bioconda package

Bioconda hosts [augur’s conda package](http://bioconda.github.io/recipes/augur/README.html) and defines augur’s dependencies in [a conda recipe YAML file](https://github.com/bioconda/bioconda-recipes/blob/master/recipes/augur/meta.yaml).
New releases on GitHub automatically trigger a new Bioconda release.

To modify augur’s dependencies or other aspects of its conda environment, [follow Bioconda’s contributing guide](https://bioconda.github.io/contributor/index.html).
You will need to update the existing recipe YAML locally and create a pull request on GitHub for testing and review.
Add your GitHub username to the `recipe_maintainers` list, if this is your first time modifying the augur recipe.
After a successful pull request review, Bioconda will automatically update the augur package that users download.

### Travis CI

Branches and PRs are tested by Travis CI jobs configured in `.travis.yml`.
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
[![Build Status](https://travis-ci.com/nextstrain/augur.svg?branch=master)](https://travis-ci.com/nextstrain/augur)
[![PyPI version](https://badge.fury.io/py/nextstrain-augur.svg)](https://pypi.org/project/nextstrain-augur/)
[![install with bioconda](https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat)](http://bioconda.github.io/recipes/augur/README.html)
[![Documentation Status](https://readthedocs.org/projects/nextstrain-augur/badge/?version=latest)](https://nextstrain-augur.readthedocs.io/en/stable/?badge=latest)
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)

Expand Down
37 changes: 24 additions & 13 deletions docs/installation/installation.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,35 @@
# Installation

* [Using conda](#using-conda)
* [Using pip from PyPi](#using-pip-from-pypi)
* [Using Conda](#using-conda)
* [Install from source](#install-from-source)
* [Testing if it worked](#testing-if-it-worked)

---

## Using conda

Install [Miniconda](https://docs.conda.io/en/latest/miniconda.html).
Create a conda environment to install augur into and activate that environment.

```bash
conda create -n nextstrain
conda activate nextstrain
```

Install augur and its dependencies into your environment.

```bash
conda install -c conda-forge -c bioconda augur
```

For a much faster installation process, use [mamba](https://github.com/TheSnakePit/mamba) as a drop-in replacement for conda.

```bash
conda install -c conda-forge mamba
mamba install -c conda-forge -c bioconda augur
```

## Using pip from PyPi

Augur is written in Python 3 and requires at least Python 3.6.
Expand Down Expand Up @@ -41,18 +64,6 @@ On Debian/Ubuntu, you can install them via:
Other Linux distributions will likely have the same packages available, although the names may differ slightly.
Follow [Snakemake's installation instructions](https://snakemake.readthedocs.io/en/stable/getting_started/installation.html) for your operating system.

## Using Conda

Alternatively, augur itself and all of its dependencies can be installed into a [Conda](https://conda.io/miniconda.html) environment:

conda env create -f environment.yml

> _By default this environment is named "augur" but you can change that by providing a name to the above command with `-n <your-env-name>`_
When that finishes, the enviroment needs to be activated whenever you want to use augur:

conda activate augur

## Install from source

```bash
Expand Down

0 comments on commit bbad9a5

Please sign in to comment.