Skip to content

Commit

Permalink
devbump: 2024.10
Browse files Browse the repository at this point in the history
  • Loading branch information
lizgehret committed Jun 3, 2024
1 parent 0d98b0d commit 7f716b9
Show file tree
Hide file tree
Showing 24 changed files with 156 additions and 156 deletions.
12 changes: 6 additions & 6 deletions source/data-resources.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ QIIME-compatible SILVA releases (up to release 132), as well as the licensing in

We also provide pre-formatted SILVA reference sequence and taxonomy files here that were processed using `RESCRIPt <https://github.com/bokulich-lab/RESCRIPt>`_. See licensing information below if you use these files.

- `Silva 138 SSURef NR99 full-length sequences <https://data.qiime2.org/2024.5/common/silva-138-99-seqs.qza>`_ (MD5: ``de8886bb2c059b1e8752255d271f3010``)
- `Silva 138 SSURef NR99 full-length taxonomy <https://data.qiime2.org/2024.5/common/silva-138-99-tax.qza>`_ (MD5: ``f12d5b78bf4b1519721fe52803581c3d``)
- `Silva 138 SSURef NR99 515F/806R region sequences <https://data.qiime2.org/2024.5/common/silva-138-99-seqs-515-806.qza>`_ (MD5: ``a914837bc3f8964b156a9653e2420d22``)
- `Silva 138 SSURef NR99 515F/806R region taxonomy <https://data.qiime2.org/2024.5/common/silva-138-99-tax-515-806.qza>`_ (MD5: ``e2c40ae4c60cbf75e24312bb24652f2c``)
- `Silva 138 SSURef NR99 full-length sequences <https://data.qiime2.org/2024.10/common/silva-138-99-seqs.qza>`_ (MD5: ``de8886bb2c059b1e8752255d271f3010``)
- `Silva 138 SSURef NR99 full-length taxonomy <https://data.qiime2.org/2024.10/common/silva-138-99-tax.qza>`_ (MD5: ``f12d5b78bf4b1519721fe52803581c3d``)
- `Silva 138 SSURef NR99 515F/806R region sequences <https://data.qiime2.org/2024.10/common/silva-138-99-seqs-515-806.qza>`_ (MD5: ``a914837bc3f8964b156a9653e2420d22``)
- `Silva 138 SSURef NR99 515F/806R region taxonomy <https://data.qiime2.org/2024.10/common/silva-138-99-tax-515-806.qza>`_ (MD5: ``e2c40ae4c60cbf75e24312bb24652f2c``)


Please cite the following references if you use any of these pre-formatted files:
Expand Down Expand Up @@ -79,5 +79,5 @@ The following databases are intended for use with q2-fragment-insertion, and
are constructed directly from the
`SEPP-Refs project <https://github.com/smirarab/sepp-refs/>`_.

- `Silva 128 SEPP reference database <https://data.qiime2.org/2024.5/common/sepp-refs-silva-128.qza>`_ (MD5: ``7879792a6f42c5325531de9866f5c4de``)
- `Greengenes 13_8 SEPP reference database <https://data.qiime2.org/2024.5/common/sepp-refs-gg-13-8.qza>`_ (MD5: ``9ed215415b52c362e25cb0a8a46e1076``)
- `Silva 128 SEPP reference database <https://data.qiime2.org/2024.10/common/sepp-refs-silva-128.qza>`_ (MD5: ``7879792a6f42c5325531de9866f5c4de``)
- `Greengenes 13_8 SEPP reference database <https://data.qiime2.org/2024.10/common/sepp-refs-gg-13-8.qza>`_ (MD5: ``9ed215415b52c362e25cb0a8a46e1076``)
16 changes: 8 additions & 8 deletions source/install/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,19 +38,19 @@ option for all cases. In general we recommend the following:

.. _distributions:

QIIME 2 2024.5 distributions
QIIME 2 2024.10 distributions
----------------------------

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

- ``amplicon``
- ``shotgun``
- ``tiny``

QIIME 2 2024.5 Amplicon Distribution
QIIME 2 2024.10 Amplicon Distribution
....................................

The 2024.5 release of the QIIME 2 Amplicon Distribution includes the QIIME 2 framework, ``q2cli`` (a QIIME 2 command-line interface) and the following plugins:
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:

- ``q2-alignment``
- ``q2-composition``
Expand All @@ -74,10 +74,10 @@ The 2024.5 release of the QIIME 2 Amplicon Distribution includes the QIIME 2 fra
- ``q2-types``
- ``q2-vsearch``

QIIME 2 2024.5 Shotgun Distribution
QIIME 2 2024.10 Shotgun Distribution
...................................

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

- ``q2-assembly``
- ``q2-cutadapt``
Expand All @@ -98,10 +98,10 @@ The 2024.5 release of the QIIME 2 Shotgun Distribution includes the QIIME 2 fram
- ``q2-types-genomics``
- ``rescript``

QIIME 2 2024.5 Tiny Distribution
QIIME 2 2024.10 Tiny Distribution
................................

The 2024.5 release of the QIIME 2 Tiny Distribution includes the QIIME 2 framework and ``q2cli`` (a QIIME 2 command-line interface) and the following plugins:
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:

- ``q2-types``

Expand Down
90 changes: 45 additions & 45 deletions source/install/native.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,13 @@ Install QIIME 2 within a ``conda`` environment
----------------------------------------------

Once you have Miniconda installed, create a ``conda`` environment and install
the QIIME 2 2024.5 distribution of your choice within the environment.
the QIIME 2 2024.10 distribution of your choice within the environment.
We **highly** recommend creating a *new* environment specifically for the
QIIME 2 distribution and release being installed, as there are many required
dependencies that you may not want added to an existing environment.
You can choose whatever name you'd like for the environment.
In this example, we'll name the environments ``qiime2-<distro>-2024.5``
to indicate what QIIME 2 release is installed (i.e. ``2024.5``).
In this example, we'll name the environments ``qiime2-<distro>-2024.10``
to indicate what QIIME 2 release is installed (i.e. ``2024.10``).

QIIME 2 Amplicon Distribution
.............................
Expand All @@ -70,32 +70,32 @@ QIIME 2 Amplicon Distribution
</p>
</div>
<div id="amplicon-macOS-intel" class="tab-pane fade">
<pre>wget https://data.qiime2.org/distro/amplicon/qiime2-amplicon-2024.5-py38-osx-conda.yml
conda env create -n qiime2-amplicon-2024.5 --file qiime2-amplicon-2024.5-py38-osx-conda.yml</pre>
<pre>wget https://data.qiime2.org/distro/amplicon/qiime2-amplicon-2024.10-py38-osx-conda.yml
conda env create -n qiime2-amplicon-2024.10 --file qiime2-amplicon-2024.10-py38-osx-conda.yml</pre>
<span>OPTIONAL CLEANUP</span>
<pre>rm qiime2-amplicon-2024.5-py38-osx-conda.yml</pre>
<pre>rm qiime2-amplicon-2024.10-py38-osx-conda.yml</pre>
</div>
<div id="amplicon-macOS-apple-silicon" class="tab-pane fade">
<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>
<pre>wget https://data.qiime2.org/distro/amplicon/qiime2-amplicon-2024.5-py38-osx-conda.yml
CONDA_SUBDIR=osx-64 conda env create -n qiime2-amplicon-2024.5 --file qiime2-amplicon-2024.5-py38-osx-conda.yml
conda activate qiime2-amplicon-2024.5
<pre>wget https://data.qiime2.org/distro/amplicon/qiime2-amplicon-2024.10-py38-osx-conda.yml
CONDA_SUBDIR=osx-64 conda env create -n qiime2-amplicon-2024.10 --file qiime2-amplicon-2024.10-py38-osx-conda.yml
conda activate qiime2-amplicon-2024.10
conda config --env --set subdir osx-64</pre>
<span>OPTIONAL CLEANUP</span>
<pre>rm qiime2-amplicon-2024.5-py38-osx-conda.yml</pre>
<pre>rm qiime2-amplicon-2024.10-py38-osx-conda.yml</pre>
</div>
<div id="amplicon-linux" class="tab-pane fade">
<pre>wget https://data.qiime2.org/distro/amplicon/qiime2-amplicon-2024.5-py38-linux-conda.yml
conda env create -n qiime2-amplicon-2024.5 --file qiime2-amplicon-2024.5-py38-linux-conda.yml</pre>
<pre>wget https://data.qiime2.org/distro/amplicon/qiime2-amplicon-2024.10-py38-linux-conda.yml
conda env create -n qiime2-amplicon-2024.10 --file qiime2-amplicon-2024.10-py38-linux-conda.yml</pre>
<span>OPTIONAL CLEANUP</span>
<pre>rm qiime2-amplicon-2024.5-py38-linux-conda.yml</pre>
<pre>rm qiime2-amplicon-2024.10-py38-linux-conda.yml</pre>
</div>
<div id="amplicon-wsl" class="tab-pane fade">
<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>
<pre>wget https://data.qiime2.org/distro/amplicon/qiime2-amplicon-2024.5-py38-linux-conda.yml
conda env create -n qiime2-amplicon-2024.5 --file qiime2-amplicon-2024.5-py38-linux-conda.yml</pre>
<pre>wget https://data.qiime2.org/distro/amplicon/qiime2-amplicon-2024.10-py38-linux-conda.yml
conda env create -n qiime2-amplicon-2024.10 --file qiime2-amplicon-2024.10-py38-linux-conda.yml</pre>
<span>OPTIONAL CLEANUP</span>
<pre>rm qiime2-amplicon-2024.5-py38-linux-conda.yml</pre>
<pre>rm qiime2-amplicon-2024.10-py38-linux-conda.yml</pre>
</div>
</div>
</div>
Expand All @@ -120,32 +120,32 @@ QIIME 2 Shotgun Distribution
</p>
</div>
<div id="shotgun-macOS-intel" class="tab-pane fade">
<pre>wget https://data.qiime2.org/distro/shotgun/qiime2-shotgun-2024.5-py38-osx-conda.yml
conda env create -n qiime2-shotgun-2024.5 --file qiime2-shotgun-2024.5-py38-osx-conda.yml</pre>
<pre>wget https://data.qiime2.org/distro/shotgun/qiime2-shotgun-2024.10-py38-osx-conda.yml
conda env create -n qiime2-shotgun-2024.10 --file qiime2-shotgun-2024.10-py38-osx-conda.yml</pre>
<span>OPTIONAL CLEANUP</span>
<pre>rm qiime2-shotgun-2024.5-py38-osx-conda.yml</pre>
<pre>rm qiime2-shotgun-2024.10-py38-osx-conda.yml</pre>
</div>
<div id="shotgun-macOS-apple-silicon" class="tab-pane fade">
<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>
<pre>wget https://data.qiime2.org/distro/shotgun/qiime2-shotgun-2024.5-py38-osx-conda.yml
CONDA_SUBDIR=osx-64 conda env create -n qiime2-shotgun-2024.5 --file qiime2-shotgun-2024.5-py38-osx-conda.yml
conda activate qiime2-shotgun-2024.5
<pre>wget https://data.qiime2.org/distro/shotgun/qiime2-shotgun-2024.10-py38-osx-conda.yml
CONDA_SUBDIR=osx-64 conda env create -n qiime2-shotgun-2024.10 --file qiime2-shotgun-2024.10-py38-osx-conda.yml
conda activate qiime2-shotgun-2024.10
conda config --env --set subdir osx-64</pre>
<span>OPTIONAL CLEANUP</span>
<pre>rm qiime2-shotgun-2024.5-py38-osx-conda.yml</pre>
<pre>rm qiime2-shotgun-2024.10-py38-osx-conda.yml</pre>
</div>
<div id="shotgun-linux" class="tab-pane fade">
<pre>wget https://data.qiime2.org/distro/shotgun/qiime2-shotgun-2024.5-py38-linux-conda.yml
conda env create -n qiime2-shotgun-2024.5 --file qiime2-shotgun-2024.5-py38-linux-conda.yml</pre>
<pre>wget https://data.qiime2.org/distro/shotgun/qiime2-shotgun-2024.10-py38-linux-conda.yml
conda env create -n qiime2-shotgun-2024.10 --file qiime2-shotgun-2024.10-py38-linux-conda.yml</pre>
<span>OPTIONAL CLEANUP</span>
<pre>rm qiime2-shotgun-2024.5-py38-linux-conda.yml</pre>
<pre>rm qiime2-shotgun-2024.10-py38-linux-conda.yml</pre>
</div>
<div id="shotgun-wsl" class="tab-pane fade">
<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>
<pre>wget https://data.qiime2.org/distro/shotgun/qiime2-shotgun-2024.5-py38-linux-conda.yml
conda env create -n qiime2-shotgun-2024.5 --file qiime2-shotgun-2024.5-py38-linux-conda.yml</pre>
<pre>wget https://data.qiime2.org/distro/shotgun/qiime2-shotgun-2024.10-py38-linux-conda.yml
conda env create -n qiime2-shotgun-2024.10 --file qiime2-shotgun-2024.10-py38-linux-conda.yml</pre>
<span>OPTIONAL CLEANUP</span>
<pre>rm qiime2-shotgun-2024.5-py38-linux-conda.yml</pre>
<pre>rm qiime2-shotgun-2024.10-py38-linux-conda.yml</pre>
</div>
</div>
</div>
Expand All @@ -170,32 +170,32 @@ QIIME 2 Tiny Distribution
</p>
</div>
<div id="tiny-macOS-intel" class="tab-pane fade">
<pre>wget https://data.qiime2.org/distro/tiny/qiime2-tiny-2024.5-py38-osx-conda.yml
conda env create -n qiime2-tiny-2024.5 --file qiime2-tiny-2024.5-py38-osx-conda.yml</pre>
<pre>wget https://data.qiime2.org/distro/tiny/qiime2-tiny-2024.10-py38-osx-conda.yml
conda env create -n qiime2-tiny-2024.10 --file qiime2-tiny-2024.10-py38-osx-conda.yml</pre>
<span>OPTIONAL CLEANUP</span>
<pre>rm qiime2-tiny-2024.5-py38-osx-conda.yml</pre>
<pre>rm qiime2-tiny-2024.10-py38-osx-conda.yml</pre>
</div>
<div id="tiny-macOS-apple-silicon" class="tab-pane fade">
<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>
<pre>wget https://data.qiime2.org/distro/tiny/qiime2-tiny-2024.5-py38-osx-conda.yml
CONDA_SUBDIR=osx-64 conda env create -n qiime2-tiny-2024.5 --file qiime2-tiny-2024.5-py38-osx-conda.yml
conda activate qiime2-tiny-2024.5
<pre>wget https://data.qiime2.org/distro/tiny/qiime2-tiny-2024.10-py38-osx-conda.yml
CONDA_SUBDIR=osx-64 conda env create -n qiime2-tiny-2024.10 --file qiime2-tiny-2024.10-py38-osx-conda.yml
conda activate qiime2-tiny-2024.10
conda config --env --set subdir osx-64</pre>
<span>OPTIONAL CLEANUP</span>
<pre>rm qiime2-tiny-2024.5-py38-osx-conda.yml</pre>
<pre>rm qiime2-tiny-2024.10-py38-osx-conda.yml</pre>
</div>
<div id="tiny-linux" class="tab-pane fade">
<pre>wget https://data.qiime2.org/distro/tiny/qiime2-tiny-2024.5-py38-linux-conda.yml
conda env create -n qiime2-tiny-2024.5 --file qiime2-tiny-2024.5-py38-linux-conda.yml</pre>
<pre>wget https://data.qiime2.org/distro/tiny/qiime2-tiny-2024.10-py38-linux-conda.yml
conda env create -n qiime2-tiny-2024.10 --file qiime2-tiny-2024.10-py38-linux-conda.yml</pre>
<span>OPTIONAL CLEANUP</span>
<pre>rm qiime2-tiny-2024.5-py38-linux-conda.yml</pre>
<pre>rm qiime2-tiny-2024.10-py38-linux-conda.yml</pre>
</div>
<div id="tiny-wsl" class="tab-pane fade">
<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>
<pre>wget https://data.qiime2.org/distro/tiny/qiime2-tiny-2024.5-py38-linux-conda.yml
conda env create -n qiime2-tiny-2024.5 --file qiime2-tiny-2024.5-py38-linux-conda.yml</pre>
<pre>wget https://data.qiime2.org/distro/tiny/qiime2-tiny-2024.10-py38-linux-conda.yml
conda env create -n qiime2-tiny-2024.10 --file qiime2-tiny-2024.10-py38-linux-conda.yml</pre>
<span>OPTIONAL CLEANUP</span>
<pre>rm qiime2-tiny-2024.5-py38-linux-conda.yml</pre>
<pre>rm qiime2-tiny-2024.10-py38-linux-conda.yml</pre>
</div>
</div>
</div>
Expand All @@ -208,7 +208,7 @@ Now that you have a QIIME 2 environment, activate it using the environment's nam
.. command-block::
:no-exec:

conda activate qiime2-<distro>-2024.5
conda activate qiime2-<distro>-2024.10

To deactivate an environment, run ``conda deactivate``.

Expand Down Expand Up @@ -247,13 +247,13 @@ of QIIME 2 and one with the newer version.
-----------------------

If at any point during the analysis the QIIME 2 conda environment is closed
or deactivated, QIIME 2 2024.5 can be activated (or reactivated) by running
or deactivated, QIIME 2 2024.10 can be activated (or reactivated) by running
the following command:

.. command-block::
:no-exec:

conda activate qiime2-<distro>-2024.5
conda activate qiime2-<distro>-2024.10

To determine the currently active conda environment, run the following
command and look for the line that starts with "active environment":
Expand Down
4 changes: 2 additions & 2 deletions source/install/virtual/docker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ In a terminal with Docker activated, run:
.. command-block::
:no-exec:

docker pull quay.io/qiime2/amplicon:2024.5
docker pull quay.io/qiime2/amplicon:2024.10

3. Confirm the installation
---------------------------
Expand All @@ -24,4 +24,4 @@ Run the following to confirm that the image was successfully fetched.
.. command-block::
:no-exec:

docker run -t -i -v $(pwd):/data quay.io/qiime2/amplicon:2024.5 qiime
docker run -t -i -v $(pwd):/data quay.io/qiime2/amplicon:2024.10 qiime
10 changes: 5 additions & 5 deletions source/tutorials/atacama-soils.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ available as a Google Sheet. This ``sample-metadata.tsv`` file is used
throughout the rest of the tutorial.

.. download::
:url: https://data.qiime2.org/2024.5/tutorials/atacama-soils/sample_metadata.tsv
:url: https://data.qiime2.org/2024.10/tutorials/atacama-soils/sample_metadata.tsv
:saveas: sample-metadata.tsv


Expand All @@ -61,15 +61,15 @@ tutorial to further improve the run time.
mkdir emp-paired-end-sequences

.. download::
:url: https://data.qiime2.org/2024.5/tutorials/atacama-soils/10p/forward.fastq.gz
:url: https://data.qiime2.org/2024.10/tutorials/atacama-soils/10p/forward.fastq.gz
:saveas: emp-paired-end-sequences/forward.fastq.gz

.. download::
:url: https://data.qiime2.org/2024.5/tutorials/atacama-soils/10p/reverse.fastq.gz
:url: https://data.qiime2.org/2024.10/tutorials/atacama-soils/10p/reverse.fastq.gz
:saveas: emp-paired-end-sequences/reverse.fastq.gz

.. download::
:url: https://data.qiime2.org/2024.5/tutorials/atacama-soils/10p/barcodes.fastq.gz
:url: https://data.qiime2.org/2024.10/tutorials/atacama-soils/10p/barcodes.fastq.gz
:saveas: emp-paired-end-sequences/barcodes.fastq.gz

.. _`atacama demux`:
Expand Down Expand Up @@ -253,4 +253,4 @@ Califf, Cesar Cardona, Audrey Copeland, Will van Treuren, Karen L. Josephson,
Rob Knight, Jack A. Gilbert, Jay Quade, J. Gregory Caporaso, and Raina M.
Maier. mSystems May 2017, 2 (3) e00195-16; DOI: 10.1128/mSystems.00195-16.

.. _sample metadata: https://data.qiime2.org/2024.5/tutorials/atacama-soils/sample_metadata
.. _sample metadata: https://data.qiime2.org/2024.10/tutorials/atacama-soils/sample_metadata
4 changes: 2 additions & 2 deletions source/tutorials/chimera.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ Start by creating a directory to work in.
Next, download the necessary files:

.. download::
:url: https://data.qiime2.org/2024.5/tutorials/chimera/atacama-table.qza
:url: https://data.qiime2.org/2024.10/tutorials/chimera/atacama-table.qza
:saveas: atacama-table.qza

.. download::
:url: https://data.qiime2.org/2024.5/tutorials/chimera/atacama-rep-seqs.qza
:url: https://data.qiime2.org/2024.10/tutorials/chimera/atacama-rep-seqs.qza
:saveas: atacama-rep-seqs.qza

Run *de novo* chimera checking
Expand Down
4 changes: 2 additions & 2 deletions source/tutorials/exporting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Exporting a feature table
A ``FeatureTable[Frequency]`` artifact will be exported as a `BIOM v2.1.0 formatted file`_.

.. download::
:url: https://data.qiime2.org/2024.5/tutorials/exporting/feature-table.qza
:url: https://data.qiime2.org/2024.10/tutorials/exporting/feature-table.qza
:saveas: feature-table.qza

.. command-block::
Expand All @@ -32,7 +32,7 @@ Exporting a phylogenetic tree
A ``Phylogeny[Unrooted]`` artifact will be exported as a `newick formatted file`_.

.. download::
:url: https://data.qiime2.org/2024.5/tutorials/exporting/unrooted-tree.qza
:url: https://data.qiime2.org/2024.10/tutorials/exporting/unrooted-tree.qza
:saveas: unrooted-tree.qza

.. command-block::
Expand Down
Loading

0 comments on commit 7f716b9

Please sign in to comment.