Skip to content

Commit 81adee1

Browse files
committed
updates env files & handles amplicon -> qiime2 -> rachis
1 parent 529aab8 commit 81adee1

8 files changed

Lines changed: 31 additions & 40 deletions

File tree

‎book/back-matter/glossary.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Directory Format
4242
4343
Distribution
4444
A collection of QIIME 2 plugins that are installed together through a single {term}`conda metapackage`.
45-
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.
45+
These are generally grouped by a theme. For example, the *qiime2 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.
4646
When a distribution is installed, that particular installation of QIIME 2 is an example of a {term}`deployment`.
4747
4848
DRY

‎book/plugins/how-to-guides/automate-testing.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ With the bracketed terms defined as:
119119
- `<next-epoch>`: the next QIIME 2 release epoch.
120120
QIIME 2 releases are scheduled for the first Wednesday of April and October, so this value is always predictable.
121121
For example, if the most recent release was 2024.10, your `<next-epoch>` would be 2025.4.
122-
- `<target-distribution>`: the QIIME 2 distribution that your plugin should be installed under (e.g., `amplicon` or `moshpit`).
122+
- `<target-distribution>`: the rachis distribution that your plugin should be installed under (e.g., `qiime2` or `moshpit`).
123123
- `<target-branch>` (optional): the branch of your repository that testing will be performed against. If not specified, this will default to your repository's *Default branch* (e.g., `main`). If you don't include this, you should leave off the `@` symbol following `.git`.
124124

125125
You can set up any additional GHAs on your repository that you feel will be beneficial to your plugin and general development workflow.

‎book/plugins/how-to-guides/distribute-on-gh.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The GitHub command line interface is used here as it's easier to document and te
1616

1717
Create a new template plugin, according to the instructions in [](plugin-from-template).
1818
Pay attention to the question about the "target distribution" - this enables templating of installation instructions and test machinery against the distribution of your choice.
19-
For example, if you want your plugin to expand upon the `amplicon` distribution, this is where you indicate that.
19+
For example, if you want your plugin to expand upon the `qiime2` distribution, this is where you indicate that.
2020

2121
After completing those steps, return to this page.
2222

‎book/plugins/how-to-guides/facilitate-installation.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
/// TODO: this needs a bit of an overhaul to handle our updated naming scheme (to prevent confusion for people moving forward)
2+
13
(facilitating-installation)=
24
# Facilitating installation of your plugin for users
35

‎book/plugins/how-to-guides/maximize-compatibility.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The Caporaso Lab is not taking on new responsibility for distributing plugins ri
1515

1616
You can consider the existing distributions to be foundations that you can build on, or you can create and distribute your own conda metapackages.
1717
Some guidance on each of these approaches:
18-
- 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)).
18+
- Your install instructions can indicate that a user should install whichever distribution you depend on (e.g., `tiny`, `qiime2`, `moshpit`, etc) 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)).
1919
- 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.
2020

2121
Either of these approaches is totally fine, with the following caveats.
@@ -29,4 +29,4 @@ With the above information in mind, refer to [](facilitating-installation) for i
2929
You can request feedback on your plugin as a whole from more experienced QIIME 2 developers by reaching out through the {{ developer_discussion }}.
3030
However, be cognizant of the fact that doing code review takes a long time to do well: you should only request this when you feel like you have a final draft of the plugin that you'd like to release, and expect that the reviewer may point out that there is a bunch more work that should be done before you release.
3131
Please have others who you work closely with -- ideally experienced software developers, and even more ideally experienced QIIME 2 plugin developers -- review it first.
32-
If you have questions along the way, you can ask those whenever - just be sure to review *[Developing with QIIME 2](https://develop.qiime2.org/)* and search the forum in case your question has already been answered previously.
32+
If you have questions along the way, you can ask those whenever - just be sure to review *[Developing with QIIME 2](https://develop.qiime2.org/)* and search the forum in case your question has already been answered previously.

‎book/plugins/how-to-guides/set-up-development-environment.md‎

Lines changed: 22 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ conda update conda
3333
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.
3434

3535
```{note}
36-
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).
36+
We recommend starting your development with the "Tiny Distribution", unless you specifically need plugins that are installed in other rachis distributions, such as the QIIME 2 Distribution or MOSHPIT (previously known as the Metagenome Distribution), in which case see [](other-distros).
3737
```
3838

3939
```{note}
@@ -44,28 +44,27 @@ Things change relatively quickly with development environments, so it doesn't hu
4444

4545

4646
`````{tab-set}
47-
````{tab-item} macOS
47+
````{tab-item} macOS (x86_64)
4848
```bash
4949
__Q2DEV_ENV_NAME=q2dev-tiny-$(date "+%Y-%m-%d")
50-
conda env create -n $__Q2DEV_ENV_NAME --file https://raw.githubusercontent.com/qiime2/distributions/dev/latest/passed/qiime2-tiny-macos-latest-conda.yml
50+
conda env create -n $__Q2DEV_ENV_NAME --file https://raw.githubusercontent.com/qiime2/distributions/dev/latest/passed/rachis-tiny-osx-64-conda.yml
5151
conda activate $__Q2DEV_ENV_NAME
5252
```
5353
````
5454
55-
````{tab-item} Linux
55+
````{tab-item} Linux (x86_64)
5656
```bash
5757
__Q2DEV_ENV_NAME=q2dev-tiny-$(date "+%Y-%m-%d")
58-
conda env create -n $__Q2DEV_ENV_NAME --file https://raw.githubusercontent.com/qiime2/distributions/dev/latest/passed/qiime2-tiny-ubuntu-latest-conda.yml
58+
conda env create -n $__Q2DEV_ENV_NAME --file https://raw.githubusercontent.com/qiime2/distributions/dev/latest/passed/rachis-tiny-linux-64-conda.yml
5959
conda activate $__Q2DEV_ENV_NAME
6060
```
6161
````
6262
63-
````{tab-item} macOS (Apple Silicon)
63+
````{tab-item} macOS (ARM64)
6464
```bash
6565
__Q2DEV_ENV_NAME=q2dev-tiny-$(date "+%Y-%m-%d")
66-
CONDA_SUBDIR=osx-64 conda env create -n $__Q2DEV_ENV_NAME --file https://raw.githubusercontent.com/qiime2/distributions/dev/latest/passed/qiime2-tiny-macos-latest-conda.yml
66+
conda env create -n $__Q2DEV_ENV_NAME --file https://raw.githubusercontent.com/qiime2/distributions/dev/latest/passed/rachis-tiny-osx-arm64-conda.yml
6767
conda activate $__Q2DEV_ENV_NAME
68-
conda config --env --set subdir osx-64
6968
```
7069
````
7170
`````
@@ -136,29 +135,29 @@ make test
136135
(other-distros)=
137136
## Installing other QIIME 2 distributions
138137

139-
### Amplicon distribution
138+
### qiime2 (previously known as the *Amplicon distribution*)
140139

141140
`````{tab-set}
142-
````{tab-item} macOS
141+
````{tab-item} macOS (x86_64)
143142
```bash
144-
__Q2DEV_ENV_NAME=q2dev-amplicon-$(date "+%Y-%m-%d")
145-
conda env create -n $__Q2DEV_ENV_NAME --file https://raw.githubusercontent.com/qiime2/distributions/dev/latest/passed/qiime2-amplicon-macos-latest-conda.yml
143+
__Q2DEV_ENV_NAME=q2dev-qiime2-$(date "+%Y-%m-%d")
144+
conda env create -n $__Q2DEV_ENV_NAME --file https://raw.githubusercontent.com/qiime2/distributions/dev/latest/passed/rachis-qiime2-osx-64-conda.yml
146145
conda activate $__Q2DEV_ENV_NAME
147146
```
148147
````
149148
150-
````{tab-item} Linux
149+
````{tab-item} Linux (x86_64)
151150
```bash
152-
__Q2DEV_ENV_NAME=q2dev-amplicon-$(date "+%Y-%m-%d")
153-
conda env create -n $__Q2DEV_ENV_NAME --file https://raw.githubusercontent.com/qiime2/distributions/dev/latest/passed/qiime2-amplicon-ubuntu-latest-conda.yml
151+
__Q2DEV_ENV_NAME=q2dev-qiime2-$(date "+%Y-%m-%d")
152+
conda env create -n $__Q2DEV_ENV_NAME --file https://raw.githubusercontent.com/qiime2/distributions/dev/latest/passed/rachis-qiime2-linux-64-conda.yml
154153
conda activate $__Q2DEV_ENV_NAME
155154
```
156155
````
157156
158157
````{tab-item} macOS (Apple Silicon)
159158
```bash
160-
__Q2DEV_ENV_NAME=q2dev-amplicon-$(date "+%Y-%m-%d")
161-
CONDA_SUBDIR=osx-64 conda env create -n $__Q2DEV_ENV_NAME --file https://raw.githubusercontent.com/qiime2/distributions/dev/latest/passed/qiime2-amplicon-macos-latest-conda.yml
159+
__Q2DEV_ENV_NAME=q2dev-qiime2-$(date "+%Y-%m-%d")
160+
CONDA_SUBDIR=osx-64 conda env create -n $__Q2DEV_ENV_NAME --file https://raw.githubusercontent.com/qiime2/distributions/dev/latest/passed/rachis-qiime2-osx-64-conda.yml
162161
conda activate $__Q2DEV_ENV_NAME
163162
conda config --env --set subdir osx-64
164163
```
@@ -167,29 +166,20 @@ conda config --env --set subdir osx-64
167166

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

170-
`````{tab-set}
171-
````{tab-item} macOS
169+
````{tab-item} Linux (x86_64)
172170
```bash
173171
__Q2DEV_ENV_NAME=moshpit-dev-$(date "+%Y-%m-%d")
174-
conda env create -n $__Q2DEV_ENV_NAME --file https://raw.githubusercontent.com/qiime2/distributions/dev/latest/passed/qiime2-moshpit-macos-latest-conda.yml
172+
conda env create -n $__Q2DEV_ENV_NAME --file https://raw.githubusercontent.com/qiime2/distributions/dev/latest/passed/rachis-moshpit-linux-64-conda.yml
175173
conda activate $__Q2DEV_ENV_NAME
176174
```
177175
````
178176

179-
````{tab-item} Linux
180-
```bash
181-
__Q2DEV_ENV_NAME=moshpit-dev-$(date "+%Y-%m-%d")
182-
conda env create -n $__Q2DEV_ENV_NAME --file https://raw.githubusercontent.com/qiime2/distributions/dev/latest/passed/qiime2-moshpit-ubuntu-latest-conda.yml
183-
conda activate $__Q2DEV_ENV_NAME
184-
```
185-
````
177+
### pathogenome
186178

187-
````{tab-item} macOS (Apple Silicon)
179+
````{tab-item} Linux (x86_64)
188180
```bash
189-
__Q2DEV_ENV_NAME=moshpit-dev-$(date "+%Y-%m-%d")
190-
CONDA_SUBDIR=osx-64 conda env create -n $__Q2DEV_ENV_NAME --file https://raw.githubusercontent.com/qiime2/distributions/dev/latest/passed/qiime2-moshpit-macos-latest-conda.yml
181+
__Q2DEV_ENV_NAME=pathogenome-dev-$(date "+%Y-%m-%d")
182+
conda env create -n $__Q2DEV_ENV_NAME --file https://raw.githubusercontent.com/qiime2/distributions/dev/latest/passed/rachis-pathogenome-linux-64-conda.yml
191183
conda activate $__Q2DEV_ENV_NAME
192-
conda config --env --set subdir osx-64
193184
```
194185
````
195-
`````

‎book/plugins/how-to-guides/use-metadata.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ All types of data columns can be instantiated as `CategoricalMetadataColumn` - v
7474

7575
## How can the Metadata API Help Me?
7676

77-
The `qiime2.metadata.Metadata` API has many interesting features - here are some of the more commonly utlitized elements amongst the plugins within the Amplicon {term}`Distribution`.
77+
The `qiime2.metadata.Metadata` API has many interesting features - here are some of the more commonly utlitized elements amongst the plugins within the qiime2 {term}`Distribution`.
7878

7979
### Merging Metadata
8080

@@ -124,4 +124,3 @@ This will generate an artifact containing the metadata that your function provid
124124
`ImmutableMetadata` artifacts can be [viewed as `Metadata`](artifacts-as-metadata), so they can be used anywhere that a typical metadata `.tsv` file can be provided as input in QIIME 2.
125125
This includes q2-metadata's `tabulate` visualizer.
126126
Additionally, if you want to obtain a `.tsv` file representation of an `ImmutableMetadata` artifact, you can [export it](https://docs.qiime2.org/2024.2/tutorials/exporting/).
127-

‎book/plugins/references/patterns.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ When you're naming inputs, outputs, and parameters for your actions, look at oth
1111

1212
### Metadata parameter name recommendations
1313

14-
We make the following recommendations for naming `Metadata` parameters, based on [a review](https://gist.github.com/gregcaporaso/4be64940f80256316e3308d2ae2ec0da) of how these had actually been named in the plugins in the QIIME 2 *amplicon distribution* in November 2025.
14+
We make the following recommendations for naming `Metadata` parameters, based on [a review](https://gist.github.com/gregcaporaso/4be64940f80256316e3308d2ae2ec0da) of how these had actually been named in the plugins in the rachis *qiime2 distribution* in November 2025.
1515

1616
- If your action takes only one sample metadata input, call it `metadata`. ([example: `kmer-diversity`](https://amplicon-docs.qiime2.org/en/latest/references/plugins/boots.html#q2-action-boots-kmer-diversity))
1717
- If your action takes only one feature metadata input, call it `feature-metadata`.

0 commit comments

Comments
 (0)