leylabmpi/qiime_2_ll_quick_viewer

Qiime 2 Ley Lab Quick Viewer

This tool launches a simple web server to quickly visualize the contents locate into the data folder from a Qiime 2 visualization artifact, i.e. files produced by Qiime 2 with extension *.qzv.

• Free software: MIT license

Installation

You can install this tool on a Python 3.5+ environment using either PIP

pip install qiime_2_ll_quick_viewer

or Conda

conda install -c leylabmpi qiime_2_ll_quick_viewer

Usage

Given a Qiime 2 visualization artifact e.g. demux.qzv you can run this command on your server:

$ qiime_2_ll_quick_viewer --filename /full_path_to/demux.qzv

By default, qiime_2_ll_quick_viewer will launch a web server on the port 8080 but you can change it for the one you want with the option --port XXXX. Then, you can for example open a SSH tunnel to the remote port opened on your server by qiime_2_ll_quick_viewer with this command:

$ ssh -L 8080:localhost:8080 user@your_server

Then, open a browser and go to this address: http://localhost:8080. To close the web server just press CTRL-C.

Command options:

-f, --filename TEXT  Full path to a Qiime2 visualization file (*.qzv). [required]
-p, --port INTEGER   Port to launch the web server. [required]
-h, --help           Show the help info and exit.

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.