Skip to content

Commit

Permalink
updated install commands, moved minimal install to supplement
Browse files Browse the repository at this point in the history
  • Loading branch information
mikerobeson committed Feb 1, 2024
1 parent 43e21e3 commit d47825f
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 48 deletions.
41 changes: 7 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,50 +9,23 @@ REference Sequence annotation and CuRatIon Pipeline

RESCRIPt is a python 3 package to support a variety of operations for managing and curating reference sequence databases, DNA/RNA sequence data, and taxonomic data. See citation information below for a full benchmark and description.

## Install from source
## Install via QIIME 2.

RESCRIPt will be installable as conda package in the near future. In the meantime, we provide two routes for source installation: a minimal RESCRIPt environment, or within an existing QIIME 2 environment:
RESCRIPt is now installed as part of the QIIME 2, as outlined in the [QIIME 2 Documentation](https://docs.qiime2.org/), for:
- "Shotgun Distribution" version `2023.9` and later.
- "Amplicon Distrubtion" version `2024.2` and later.

### Option 1: Installed as part of a QIIME 2 distribution.

For QIIME 2 versions `2023.9` and later, RESCRIPt is installed as part of the QIIME 2 "Shotgun Distribution", as outlined in the [QIIME 2 Documentation](https://docs.qiime2.org/). RESCRIPt is available as part of the "Amplicon Distrubtion" for QIIME 2 releases `2024.2` and later.

### Option 2: Minimal RESCRIPt environment

To make use of the latest "minimal" RESCRIPt release, some components of QIIME 2 (releases `2023.9` and later) are required:

First create a conda environment and install relevant dependencies using either `conda` or `mamba`.
*Note: update `{ENV_VERSION}` in the commands below to match the QIIME 2 release.*

```
conda create -y -n rescript
conda activate rescript
conda install \
-c https://packages.qiime2.org/qiime2/{ENV_VERSION}/shotgun/passed/ \
-c https://packages.qiime2.org/qiime2/{ENV_VERSION}/amplicon/passed/ \
-c conda-forge -c bioconda -c qiime2 -c defaults \
qiime2 q2cli q2templates q2-types q2-types-genomics q2-longitudinal q2-feature-classifier \
"pandas>=0.25.3" xmltodict ncbi-datasets-pylib
```

Install source:

```
pip install git+https://github.com/bokulich-lab/RESCRIPt.git
qiime rescript --help
```

### Prior versions of RESCRIPt / QIIME 2.

For details on how to install prior versions of RESCRIPt / QIIME 2, please see the `install-prior-versions.md` document.
For details on how to install prior and minimal versions of RESCRIPt for the various versions of QIIME 2, please see the `install-prior-versions.md` document.

### Read help documentation

To view a help menu for using rescript via the QIIME 2 CLI:
To view a help menu for using RESCRIPt via the QIIME 2 CLI:
```
qiime dev refresh-cache
qiime --help
qiime rescript --help
```

## Using RESCRIPt
Expand Down
43 changes: 29 additions & 14 deletions install-prior-versions.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,51 @@
# How to install prior versions of RESCRIPt.
# How to install other versions of RESCRIPt.

## Install within the QIIME 2 `2023.9` release:
## Minimal RESCRIPt environment (`2023.9` and later)

To make use of the latest "minimal" RESCRIPt release, some components of QIIME 2 (releases `2023.9` and later) are required:

For this version of QIIME 2, RESCRIPt is included within the [qiime2-shotgun-2023.9 distribution](https://docs.qiime2.org/2023.9/install/native/#qiime-2-shotgun-distribution). You'll be able to run your RESCRIPt commands within this environment, then switch back to [qiime2-amplicon-2023.9](https://docs.qiime2.org/2023.9/install/native/#qiime-2-amplicon-distribution) environment if needed.
First create a conda environment and install relevant dependencies using either `conda` or `mamba`.

It is possible to install RESCRIPt within `qiime2-amplicon-2023.9`. YOu can try via the following commands:
*Note: update `{ENV_VERSION}` in the commands below to match the QIIME 2 release.*

```
conda activate qiime2-amplicon-2023.9
conda create -y -n rescript
conda activate rescript
conda install -c conda-forge -c bioconda -c qiime2 \
-c https://packages.qiime2.org/qiime2/2023.9/shotgun/passed/ \
-c defaults xmltodict 'q2-types-genomics>2023.5' ncbi-datasets-pylib
conda install \
-c https://packages.qiime2.org/qiime2/{ENV_VERSION}/shotgun/passed/ \
-c https://packages.qiime2.org/qiime2/{ENV_VERSION}/amplicon/passed/ \
-c conda-forge -c bioconda -c qiime2 -c defaults \
qiime2 q2cli q2templates q2-types q2-types-genomics q2-longitudinal q2-feature-classifier \
"pandas>=0.25.3" xmltodict ncbi-datasets-pylib rescript
qiime rescript --help
```

Install source:
## Install within the QIIME 2 `2023.9` release:

For this version of QIIME 2, RESCRIPt is included within the [qiime2-shotgun-2023.9 distribution](https://docs.qiime2.org/2023.9/install/native/#qiime-2-shotgun-distribution). You'll be able to run your RESCRIPt commands within this environment, then switch back to [qiime2-amplicon-2023.9](https://docs.qiime2.org/2023.9/install/native/#qiime-2-amplicon-distribution) environment if needed. It is possible to install RESCRIPt within `qiime2-amplicon-2023.9`. You can try via the following commands:

```
pip install git+https://github.com/bokulich-lab/RESCRIPt.git
conda activate qiime2-amplicon-2023.9
conda install -c conda-forge -c bioconda -c qiime2 \
-c https://packages.qiime2.org/qiime2/2023.9/shotgun/passed/ \
-c defaults xmltodict 'q2-types-genomics>2023.5' ncbi-datasets-pylib rescript
qiime rescript --help
```


## Install within the QIIME 2 releases `2023.2` - `2023.7`.
The typical apporoach will be something like the command below. *Make sure the qiime version within the http string matches the version of the active qiime environment.*
Current releases of RESCRIPt should generally be compatable with these QIIME 2 versions. If not, please download the corresponding [RESCRIPt release](https://github.com/bokulich-lab/RESCRIPt/releases) and consult that version's README file for appropriate Installation instructions.

*Note: update `{ENV_VERSION}` in the commands below to match the QIIME 2 release.*

```
conda activate qiime2-2023.7
conda activate qiime2-{ENV_VERSION}
conda install -c conda-forge -c bioconda -c qiime2 \
-c https://packages.qiime2.org/qiime2/2023.7/passed/ \
-c https://packages.qiime2.org/qiime2/{ENV_VERSION}/passed/ \
-c defaults xmltodict 'q2-types-genomics>2023.2' ncbi-datasets-pylib
```
Install source:
Expand Down

0 comments on commit d47825f

Please sign in to comment.