Skip to main content

Ley Lab Quick Viewer for Qiime 2 artifacts.

Project description

Qiime 2 Ley Lab Quick Viewer

https://img.shields.io/pypi/v/qiime_2_ll_quick_viewer.svg https://img.shields.io/travis/leylabmpi/qiime_2_ll_quick_viewer.svg Updates

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 8089 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 8089:localhost:8089 user@your_server

Finally, open a browser and go to this address: http://localhost:8089.

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.

History

0.2.8 (2017-11-30)

  • Updated version for Python 3.5+ and TOX testing.

0.2.7 (2017-11-30)

  • Updated version for Python 3.5+.

0.2.6 (2017-11-29)

  • Changes into the RST files.

0.2.5 (2017-11-29)

  • Generated a base version for a Conda package.

0.2.4 (2017-11-29)

  • Documentation has been updated to be markdown friendly.

0.2.3 (2017-11-28)

  • Repository migrated to Ley Lab’s Github account.

0.2.2 (2017-11-27)

  • Documentation updated.

0.2.1 (2017-11-27)

  • Documentation updated.

0.2.0 (2017-11-27)

  • First functional version of the package.

0.1.0 (2017-11-27)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
qiime_2_ll_quick_viewer-0.2.8-py2.py3-none-any.whl (6.6 kB) Copy SHA256 hash SHA256 Wheel 3.6 Nov 30, 2017
qiime_2_ll_quick_viewer-0.2.8.tar.gz (14.0 kB) Copy SHA256 hash SHA256 Source None Nov 30, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page