Document conda support #604
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Promotes conda installation to the first recommended approach, making these docs consistent with the messaging from the Nextstrain installation docs where conda is also the preferred approach. Updates the specific conda installation instructions to use the augur package from Bioconda instead of a local environment YAML file that users would have to get from the git repository first. These new instructions also recommend using mamba as a replacement for the conda installation, since the Bioconda package relies on conda-forge and installation from conda-forge with conda is notoriously slow.
Adds a new section next to the "Releasing" section that describes how the Bioconda releases work and how developers can update the augur conda environment through Bioconda's contribution workflow.
Surfaces augur's existing Bioconda package through a fancy badge.
Codecov Report
@@ Coverage Diff @@
## master #604 +/- ##
=======================================
Coverage 28.31% 28.31%
=======================================
Files 39 39
Lines 5332 5332
Branches 1306 1306
=======================================
Hits 1510 1510
Misses 3769 3769
Partials 53 53 Continue to review full report at Codecov.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of proposed changes
Document support for installing augur with conda through updated installation and developer documentation.
Testing
The installation instructions here work from OS X with Miniconda, but I am especially curious whether they work for a range of user environments. The maintainer's instructions for the Bioconda recipe reflect my own experiences updating that recipe.