Home_Icon Learning Center Home

QIIME2 Jupyter Lab


QIIME 2™ is a next-generation microbiome bioinformatics platform that is extensible, free, open source, and community developed.

  • Automatically track your analyses with decentralized data provenance — no more guesswork on what commands were run!
  • Interactively explore your data with beautiful visualizations that provide new perspectives.
  • Easily share results with your team, even those members without QIIME 2 installed.
  • Plugin-based system — your favorite microbiome methods all in one place.

In this quick start, we will show you how to launch JupyterLab-QIIME2 VICE app in DE


Downloads, access, and services

In order to complete this tutorial you will need access to the following services/software

Prerequisite Preparation/Notes Link/Download
CyVerse account You will need a CyVerse account to complete this exercise Register


We will use the following CyVerse platform(s):

Platform Interface Link Platform Documentation Learning Center Docs
Discovery Environment Web/Point-and-click Discovery Environment DE Manual Guide

Input and example data

In order to complete this quickstart you will need to have the following inputs prepared

Input File(s) Format Preparation/Notes Example Data
Sequencing reads FastQ Any sequencing reads in FastQ format will work. They do not need to be pre-processed. They may also be compressed (e.g. fastq.gz) gut microbiome (iplantcollaborative > example_data > qiime2 and select gut-microbiome folder)

Get started

  1. Login to the Discovery Environment.

  2. Click badge QIIME2 to log into CyVerse and view the App.

  3. Under “Parameters” for ‘Input folder’ or ‘Input files’, click Browse, then navigate to and select one or more FastQ files to analyze; Then click OK.


    To use our example data, navigate to Community Data > iplantcollaborative > example_data > qiime2 and select gut-microbiome folder.

  4. Click Launch Analysis. You will receive a notification that the job has been submitted and running with the “Access your running analysis here”.

  5. Clicking on the “Access your running analysis” will open the JupyterLab-QIIME2 in another tab in the browser after a brief building phase.


You will be asked to authenticate again to the JupyterLab with your CyVerse username and password

  1. You will see the input data under “vice” folder of the JuptyerLab. Now you can upload your own Jupyter Notebook or create one using one of the available kernels


Do not create or store any outputs inside the input folder (gut-microbiome) as those outputs are not brought back after the analysis

  1. Finally, once you finish analysis, navigate to the DE tab, select the Analysis window and select the analysis, click “save and complete analysis”. Upon clicking complete analysis, the analysis will be completed and all the outputs will be brought back to the analysis folder.


UPDATE: Newest version QIIME-2019.10

The latest version (currently v2019.10 as of 11/8/2019) for QIIME2 in VICE has the capabilities for in-line visualizations in the jupyter notebook.

Simply import the qiime2 module into the python notebook:

import qiime2

And use the following command to view your .qzv files in-line with your jupyter notebook:


This provides all of the perks of using view.qiime2.org to visualize your .qzv files, but you don’t need to change tabs. Additionally, everything is kept in the notebook which can be used as a lab notebook or for reproducibility.

IMPORTANT: Save all needed output files in the vice directory. Files not in the vice directory will not be retained in your data store analyses folder.

  • Full materials for the webinar is available here
  • See the original JupyterLab quick start
  • See the original qiime2.org for how to run qiime2 analysis
  • Contact CyVerse support by clicking the intercom button on the page.

Fix or improve this documentation

Home_Icon Learning Center Home