Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/main' into fix_pandas
Browse files Browse the repository at this point in the history
  • Loading branch information
adamovanja committed Nov 28, 2023
2 parents a22bee2 + 4943f83 commit af67be7
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 1 deletion.
11 changes: 11 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
FROM mambaorg/micromamba
ARG MAMBA_DOCKERFILE_ACTIVATE=1
RUN micromamba install -y -c https://packages.qiime2.org/qiime2/2023.2/tested/ \
-c conda-forge -c bioconda -c defaults \
q2cli q2-fondue
ENV PATH /opt/conda/bin:$PATH

RUN mkdir $HOME/.ncbi
RUN printf '/LIBS/GUID = "%s"\n' `uuidgen` > $HOME/.ncbi/user-settings.mkfg

CMD [ "/bin/bash" ]
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
</p><br>

## Installation
You can install q2-fondue using mamba in a conda environment of its own (option 1) or in an existing QIIME 2 environment (option 2) by following the steps described below. The current q2-fondue version supports QIIME 2 **v2021.4** or higher.
You can install q2-fondue using mamba in a conda environment of its own (option 1) or in an existing QIIME 2 environment (option 2) by following the steps described below. The current q2-fondue version supports QIIME 2 **v2021.4** or higher. Alternatively, a minimal Docker image is available to run q2-fondue methods (option 3 below).

For both options 1 and 2 make sure to start by installing [mamba](https://mamba.readthedocs.io/en/latest/index.html) in your base environment:
```shell
Expand Down Expand Up @@ -63,6 +63,24 @@ vdb-config -i
vdb-config --proxy <your proxy URL> --proxy-disable no
```

### Option 3: Use fondue via a public Docker image
Use containerization to integrate q2-fondue into your pipelines, or simply run reproducibly without the need for heavyweight package managers. [Read more about Docker here.](https://www.docker.com/get-started/)

* Install [Docker](https://docs.docker.com/engine/install/) with the linked instructions
* Pull the [q2-fondue Docker image](https://hub.docker.com/layers/linathekim/q2-fondue/2023.2/images/sha256-214d0575eb4eaf435c5c4a7d29edf0fc082e47999b884b52a173f2ec469975f2?context=repo):
```shell
docker pull linathekim/q2-fondue:2023.2
```
* Within the container, refresh the QIIME 2 CLI cache to see that everything worked:
```shell
qiime dev refresh-cache
qiime fondue --help
```
* If you need to configure a proxy server, run the following command:
```shell
vdb-config --proxy <your proxy URL> --proxy-disable no
```

## Space requirements
Running q2-fondue requires space in the temporary (`TMPDIR`) and output directory. The space requirements for the output directory can be estimated by inserting the run or project IDs in the [SRA Run Selector](https://www.ncbi.nlm.nih.gov/Traces/study/). To estimate the space requirements for the temporary directory, multiply the output directory space requirement by a factor of 10. The current implementation of q2-fondue requires you to have a minimum of 2 GB of available space in your temporary directory.

Expand Down

0 comments on commit af67be7

Please sign in to comment.