Skip to content
This repository was archived by the owner on Apr 25, 2025. It is now read-only.

Commit 9451718

Browse files
committed
update envs with py310 & add pathogenome
1 parent 617d0c3 commit 9451718

File tree

2 files changed

+75
-17
lines changed

2 files changed

+75
-17
lines changed

source/install/index.rst

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,16 +39,17 @@ option for all cases. In general we recommend the following:
3939
.. _distributions:
4040

4141
QIIME 2 2024.10 distributions
42-
----------------------------
42+
-----------------------------
4343

4444
As of 2024.10, QIIME 2 releases now include the following QIIME 2 distributions that are available for install:
4545

4646
- ``amplicon``
4747
- ``metagenome``
48+
- ``pathogenome``
4849
- ``tiny``
4950

5051
QIIME 2 2024.10 Amplicon Distribution
51-
....................................
52+
.....................................
5253

5354
The 2024.10 release of the QIIME 2 Amplicon Distribution includes the QIIME 2 framework, ``q2cli`` (a QIIME 2 command-line interface) and the following plugins:
5455

@@ -76,7 +77,7 @@ The 2024.10 release of the QIIME 2 Amplicon Distribution includes the QIIME 2 fr
7677
- ``rescript``
7778

7879
QIIME 2 2024.10 Metagenome Distribution
79-
......................................
80+
.......................................
8081

8182
The 2024.10 release of the QIIME 2 Metagenome Distribution includes the QIIME 2 framework, ``q2cli`` (a QIIME 2 command-line interface) and the following plugins:
8283

@@ -102,14 +103,33 @@ The 2024.10 release of the QIIME 2 Metagenome Distribution includes the QIIME 2
102103
- ``q2-vsearch``
103104
- ``rescript``
104105

106+
QIIME 2 2024.10 Pathogenome Distribution
107+
........................................
108+
109+
The 2024.10 release of the QIIME 2 Metagenome Distribution includes the QIIME 2 framework, ``q2cli`` (a QIIME 2 command-line interface) and the following plugins:
110+
111+
- ``q2-amrfinderplus``
112+
- ``q2-assembly``
113+
- ``q2-demux``
114+
- ``q2-feature-classifier``
115+
- ``q2-feature-table``
116+
- ``q2-longitudinal``
117+
- ``q2-quality-control``
118+
- ``q2-sample-classifier``
119+
- ``q2-taxa``
120+
- ``q2-types``
121+
- ``q2-viromics``
122+
- ``q2-vizard``
123+
- ``rescript``
124+
105125
QIIME 2 2024.10 Tiny Distribution
106-
................................
126+
.................................
107127

108128
The 2024.10 release of the QIIME 2 Tiny Distribution includes the QIIME 2 framework and ``q2cli`` (a QIIME 2 command-line interface) and the following plugins:
109129

110130
- ``q2-types``
111131

112-
The QIIME 2 Tiny Distribution is a minimal QIIME 2 environment that can be used by developers who are in need of a basic development environment, or community plugin users who do not need the entire Amplicon or Metagenome Distributions in their QIIME 2 environment.
132+
The QIIME 2 Tiny Distribution is a minimal QIIME 2 environment that can be used by developers who are in need of a basic development environment, or community plugin users who do not need the entire Amplicon, Metagenome or Pathogenome Distributions in their QIIME 2 environment.
113133

114134
.. note:: The Amplicon Distribution is necessary to run the commands in the :doc:`QIIME 2 tutorials <../tutorials/index>`. If there are additional QIIME 2 plugins or interfaces you would like to install, please consult the relevant package(s) documentation.
115135

source/install/native.rst

Lines changed: 50 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -62,20 +62,20 @@ QIIME 2 Amplicon Distribution
6262
</p>
6363
</div>
6464
<div id="amplicon-macOS-intel" class="tab-pane fade">
65-
<pre>conda env create -n qiime2-amplicon-2024.10 --file https://data.qiime2.org/distro/amplicon/qiime2-amplicon-2024.10-py39-osx-conda.yml</pre>
65+
<pre>conda env create -n qiime2-amplicon-2024.10 --file https://data.qiime2.org/distro/amplicon/qiime2-amplicon-2024.10-py310-osx-conda.yml</pre>
6666
</div>
6767
<div id="amplicon-macOS-apple-silicon" class="tab-pane fade">
6868
<p>These instructions are for users with <a href="https://support.apple.com/en-us/HT211814">Apple Silicon</a> chips (M1, M2, etc), and configures the installation of QIIME 2 in <a href="https://developer.apple.com/documentation/apple-silicon/about-the-rosetta-translation-environment">Rosetta 2 emulation mode</a>.</p>
69-
<pre>CONDA_SUBDIR=osx-64 conda env create -n qiime2-amplicon-2024.10 --file https://data.qiime2.org/distro/amplicon/qiime2-amplicon-2024.10-py39-osx-conda.yml
69+
<pre>CONDA_SUBDIR=osx-64 conda env create -n qiime2-amplicon-2024.10 --file https://data.qiime2.org/distro/amplicon/qiime2-amplicon-2024.10-py310-osx-conda.yml
7070
conda activate qiime2-amplicon-2024.10
7171
conda config --env --set subdir osx-64</pre>
7272
</div>
7373
<div id="amplicon-linux" class="tab-pane fade">
74-
<pre>conda env create -n qiime2-amplicon-2024.10 --file https://data.qiime2.org/distro/amplicon/qiime2-amplicon-2024.10-py39-linux-conda.yml</pre>
74+
<pre>conda env create -n qiime2-amplicon-2024.10 --file https://data.qiime2.org/distro/amplicon/qiime2-amplicon-2024.10-py310-linux-conda.yml</pre>
7575
</div>
7676
<div id="amplicon-wsl" class="tab-pane fade">
7777
<p>These instructions are identical to the Linux instructions and are intended for users of the <a href="https://learn.microsoft.com/en-us/windows/wsl/about">Windows Subsystem for Linux</a>.</p>
78-
<pre>conda env create -n qiime2-amplicon-2024.10 --file https://data.qiime2.org/distro/amplicon/qiime2-amplicon-2024.10-py39-linux-conda.yml</pre>
78+
<pre>conda env create -n qiime2-amplicon-2024.10 --file https://data.qiime2.org/distro/amplicon/qiime2-amplicon-2024.10-py310-linux-conda.yml</pre>
7979
</div>
8080
</div>
8181
</div>
@@ -100,20 +100,58 @@ QIIME 2 Metagenome Distribution
100100
</p>
101101
</div>
102102
<div id="metagenome-macOS-intel" class="tab-pane fade">
103-
<pre>conda env create -n qiime2-metagenome-2024.10 --file https://data.qiime2.org/distro/metagenome/qiime2-metagenome-2024.10-py39-osx-conda.yml</pre>
103+
<pre>conda env create -n qiime2-metagenome-2024.10 --file https://data.qiime2.org/distro/metagenome/qiime2-metagenome-2024.10-py310-osx-conda.yml</pre>
104104
</div>
105105
<div id="metagenome-macOS-apple-silicon" class="tab-pane fade">
106106
<p>These instructions are for users with <a href="https://support.apple.com/en-us/HT211814">Apple Silicon</a> chips (M1, M2, etc), and configures the installation of QIIME 2 in <a href="https://developer.apple.com/documentation/apple-silicon/about-the-rosetta-translation-environment">Rosetta 2 emulation mode</a>.</p>
107-
<pre>CONDA_SUBDIR=osx-64 conda env create -n qiime2-metagenome-2024.10 --file https://data.qiime2.org/distro/metagenome/qiime2-metagenome-2024.10-py39-osx-conda.yml
107+
<pre>CONDA_SUBDIR=osx-64 conda env create -n qiime2-metagenome-2024.10 --file https://data.qiime2.org/distro/metagenome/qiime2-metagenome-2024.10-py310-osx-conda.yml
108108
conda activate qiime2-metagenome-2024.10
109109
conda config --env --set subdir osx-64</pre>
110110
</div>
111111
<div id="metagenome-linux" class="tab-pane fade">
112-
<pre>conda env create -n qiime2-metagenome-2024.10 --file https://data.qiime2.org/distro/metagenome/qiime2-metagenome-2024.10-py39-linux-conda.yml</pre>
112+
<pre>conda env create -n qiime2-metagenome-2024.10 --file https://data.qiime2.org/distro/metagenome/qiime2-metagenome-2024.10-py310-linux-conda.yml</pre>
113113
</div>
114114
<div id="metagenome-wsl" class="tab-pane fade">
115115
<p>These instructions are identical to the Linux instructions and are intended for users of the <a href="https://learn.microsoft.com/en-us/windows/wsl/about">Windows Subsystem for Linux</a>.</p>
116-
<pre>conda env create -n qiime2-metagenome-2024.10 --file https://data.qiime2.org/distro/metagenome/qiime2-metagenome-2024.10-py39-linux-conda.yml</pre>
116+
<pre>conda env create -n qiime2-metagenome-2024.10 --file https://data.qiime2.org/distro/metagenome/qiime2-metagenome-2024.10-py310-linux-conda.yml</pre>
117+
</div>
118+
</div>
119+
</div>
120+
121+
QIIME 2 Pathogenome Distribution
122+
................................
123+
124+
.. raw:: html
125+
126+
<div class="tabbed">
127+
<ul class="nav nav-tabs">
128+
<li class="active"><a data-toggle="tab" href="#pathogenome-instructions">Instructions</a></li>
129+
<li><a data-toggle="tab" href="#pathogenome-macOS-intel">macOS (Intel) and OS X</a></li>
130+
<li><a data-toggle="tab" href="#pathogenome-macOS-apple-silicon">macOS (Apple Silicon)</a></li>
131+
<li><a data-toggle="tab" href="#pathogenome-linux">Linux</a></li>
132+
<li><a data-toggle="tab" href="#pathogenome-wsl">Windows (via WSL)</a></li>
133+
</ul>
134+
<div class="tab-content">
135+
<div id="pathogenome-instructions" class="tab-pane fade in active">
136+
<p class="alert alert-warning" style="margin-bottom: 10px;">
137+
From the above tabs, please choose the installation instructions that are appropriate for your platform.
138+
</p>
139+
</div>
140+
<div id="pathogenome-macOS-intel" class="tab-pane fade">
141+
<pre>conda env create -n qiime2-pathogenome-2024.10 --file https://data.qiime2.org/distro/pathogenome/qiime2-pathogenome-2024.10-py310-osx-conda.yml</pre>
142+
</div>
143+
<div id="pathogenome-macOS-apple-silicon" class="tab-pane fade">
144+
<p>These instructions are for users with <a href="https://support.apple.com/en-us/HT211814">Apple Silicon</a> chips (M1, M2, etc), and configures the installation of QIIME 2 in <a href="https://developer.apple.com/documentation/apple-silicon/about-the-rosetta-translation-environment">Rosetta 2 emulation mode</a>.</p>
145+
<pre>CONDA_SUBDIR=osx-64 conda env create -n qiime2-pathogenome-2024.10 --file https://data.qiime2.org/distro/pathogenome/qiime2-pathogenome-2024.10-py310-osx-conda.yml
146+
conda activate qiime2-pathogenome-2024.10
147+
conda config --env --set subdir osx-64</pre>
148+
</div>
149+
<div id="pathogenome-linux" class="tab-pane fade">
150+
<pre>conda env create -n qiime2-pathogenome-2024.10 --file https://data.qiime2.org/distro/pathogenome/qiime2-pathogenome-2024.10-py310-linux-conda.yml</pre>
151+
</div>
152+
<div id="pathogenome-wsl" class="tab-pane fade">
153+
<p>These instructions are identical to the Linux instructions and are intended for users of the <a href="https://learn.microsoft.com/en-us/windows/wsl/about">Windows Subsystem for Linux</a>.</p>
154+
<pre>conda env create -n qiime2-pathogenome-2024.10 --file https://data.qiime2.org/distro/pathogenome/qiime2-pathogenome-2024.10-py310-linux-conda.yml</pre>
117155
</div>
118156
</div>
119157
</div>
@@ -138,20 +176,20 @@ QIIME 2 Tiny Distribution
138176
</p>
139177
</div>
140178
<div id="tiny-macOS-intel" class="tab-pane fade">
141-
<pre>conda env create -n qiime2-tiny-2024.10 --file https://data.qiime2.org/distro/tiny/qiime2-tiny-2024.10-py39-osx-conda.yml</pre>
179+
<pre>conda env create -n qiime2-tiny-2024.10 --file https://data.qiime2.org/distro/tiny/qiime2-tiny-2024.10-py310-osx-conda.yml</pre>
142180
</div>
143181
<div id="tiny-macOS-apple-silicon" class="tab-pane fade">
144182
<p>These instructions are for users with <a href="https://support.apple.com/en-us/HT211814">Apple Silicon</a> chips (M1, M2, etc), and configures the installation of QIIME 2 in <a href="https://developer.apple.com/documentation/apple-silicon/about-the-rosetta-translation-environment">Rosetta 2 emulation mode</a>.</p>
145-
<pre>CONDA_SUBDIR=osx-64 conda env create -n qiime2-tiny-2024.10 --file https://data.qiime2.org/distro/tiny/qiime2-tiny-2024.10-py39-osx-conda.yml
183+
<pre>CONDA_SUBDIR=osx-64 conda env create -n qiime2-tiny-2024.10 --file https://data.qiime2.org/distro/tiny/qiime2-tiny-2024.10-py310-osx-conda.yml
146184
conda activate qiime2-tiny-2024.10
147185
conda config --env --set subdir osx-64</pre>
148186
</div>
149187
<div id="tiny-linux" class="tab-pane fade">
150-
<pre>conda env create -n qiime2-tiny-2024.10 --file https://data.qiime2.org/distro/tiny/qiime2-tiny-2024.10-py39-linux-conda.yml</pre>
188+
<pre>conda env create -n qiime2-tiny-2024.10 --file https://data.qiime2.org/distro/tiny/qiime2-tiny-2024.10-py310-linux-conda.yml</pre>
151189
</div>
152190
<div id="tiny-wsl" class="tab-pane fade">
153191
<p>These instructions are identical to the Linux instructions and are intended for users of the <a href="https://learn.microsoft.com/en-us/windows/wsl/about">Windows Subsystem for Linux</a>.</p>
154-
<pre>conda env create -n qiime2-tiny-2024.10 --file https://data.qiime2.org/distro/tiny/qiime2-tiny-2024.10-py39-linux-conda.yml</pre>
192+
<pre>conda env create -n qiime2-tiny-2024.10 --file https://data.qiime2.org/distro/tiny/qiime2-tiny-2024.10-py310-linux-conda.yml</pre>
155193
</div>
156194
</div>
157195
</div>

0 commit comments

Comments
 (0)