Skip to content

Commit

Permalink
MAINT: update nomeclature around metagenome distro
Browse files Browse the repository at this point in the history
  • Loading branch information
gregcaporaso committed Jan 8, 2025
1 parent 2a7e437 commit 7b10bbb
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion book/back-matter/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Directory Format
Distribution
A collection of QIIME 2 plugins that are installed together through a single {term}`conda metapackage`.
These are generally grouped by a theme. For example, the *amplicon distribution* provides a collection of plugins for analysis of microbiome amplicon data, while the *metagenome distribution* provides a collection of plugins for analysis of microbiome shotgun metagenomics data.
These are generally grouped by a theme. For example, the *amplicon distribution* provides a collection of plugins for analysis of microbiome amplicon data, while MOSHPIT (previously the *metagenome distribution*) provides a collection of plugins for analysis of microbiome shotgun metagenomics data.
When a distribution is installed, that particular installation of QIIME 2 is an example of a {term}`deployment`.
DRY
Expand Down
2 changes: 1 addition & 1 deletion book/plugins/how-to-guides/maximize-compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The Caporaso Lab is not taking on new responsibility for distributing plugins ri

You can consider the existing distributions to be foundations that you can build on, or you can create and distribute your own conda metapackages.
Some guidance on each of these approaches:
- Your install instructions can indicate that a user should install whichever distribution you depend on (e.g., `tiny`, `amplicon`, or `metagenome`) and then illustrate how to install your plugin(s) in that environment however it makes sense (e.g., `conda` or `pip`). Complete install instructions are drafted for you in the `README.md` of plugins that you build using our template (see [](plugin-from-template)).
- Your install instructions can indicate that a user should install whichever distribution you depend on (e.g., `tiny`, `amplicon`, or `MOSHPIT`) and then illustrate how to install your plugin(s) in that environment however it makes sense (e.g., `conda` or `pip`). Complete install instructions are drafted for you in the `README.md` of plugins that you build using our template (see [](plugin-from-template)).
- Alternatively, you can compose and share your own distribution of plugins (e.g., building from the `tiny` distribution) that captures the set of functionality you’d like to share.

Either of these approaches is totally fine, with the following caveats.
Expand Down
10 changes: 5 additions & 5 deletions book/plugins/how-to-guides/set-up-development-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ conda update conda
The QIIME 2 "Tiny Distribution" is a minimal set of QIIME 2 functionality for building and using plugins through the QIIME 2 command line, and is intended for use by developers who want a minimal QIIME 2 environment to work in.

```{note}
We recommend starting your development with the "Tiny Distribution", unless you specifically need plugins that are installed in other QIIME 2 distributions, such as the "Amplicon" or "Metagenome" distributions, in which case see [](other-distros).
We recommend starting your development with the "Tiny Distribution", unless you specifically need plugins that are installed in other QIIME 2 distributions, such as the Amplicon Distribution or MOSHPIT (previously known as the Metagenome Distribution), in which case see [](other-distros).
```

`````{tab-set}
Expand Down Expand Up @@ -145,24 +145,24 @@ conda config --env --set subdir osx-64
````
`````

### Metagenome distribution
### MOSHPIT (previously known as the *Metagenome distribution*)

`````{tab-set}
````{tab-item} macOS
```bash
conda env create -n q2dev-metagenome --file https://raw.githubusercontent.com/qiime2/distributions/dev/latest/passed/qiime2-metagenome-macos-latest-conda.yml
conda env create -n moshpit-dev --file https://raw.githubusercontent.com/qiime2/distributions/dev/latest/passed/qiime2-metagenome-macos-latest-conda.yml
```
````
````{tab-item} Linux
```bash
conda env create -n q2dev-metagenome --file https://raw.githubusercontent.com/qiime2/distributions/dev/latest/passed/qiime2-metagenome-ubuntu-latest-conda.yml
conda env create -n moshpit-dev --file https://raw.githubusercontent.com/qiime2/distributions/dev/latest/passed/qiime2-metagenome-ubuntu-latest-conda.yml
```
````
````{tab-item} macOS (Apple Silicon)
```bash
CONDA_SUBDIR=osx-64 conda env create -n q2dev-metagenome --file https://raw.githubusercontent.com/qiime2/distributions/dev/latest/passed/qiime2-metagenome-macos-latest-conda.yml
CONDA_SUBDIR=osx-64 conda env create -n moshpit-dev --file https://raw.githubusercontent.com/qiime2/distributions/dev/latest/passed/qiime2-metagenome-macos-latest-conda.yml
conda config --env --set subdir osx-64
```
````
Expand Down

0 comments on commit 7b10bbb

Please sign in to comment.