Metadata-Version: 1.0
Name: glue-vispy-viewers
Version: 0.10
Summary: Vispy-based viewers for Glue
Home-page: https://github.com/glue-viz/glue-3d-viewer
Author: Penny Qian, Maxwell Tsai, and Thomas Robitaille
Author-email: glueviz@gmail.com
License: UNKNOWN
Description: Glue plugin for 3D viewers using VisPy
        ======================================
        
        |Travis Status| |AppVeyor Status| |Coverage Status|
        
        Requirements
        ------------
        
        Note that this plugin requires `Glue <http://glueviz.org/>`__ and
        `PyOpenGL <http://pyopengl.sourceforge.net/>`__ to be installed - see
        `this page <http://glueviz.org/en/latest/installation.html>`__ for
        instructions on installing Glue. PyOpenGL should get installed
        automatically when you install the plugin (see below).
        
        While this plugin uses VisPy, for now we bundle our own version of VisPy
        since we rely on some recently added features, so you do not need to
        install VisPy separately.
        
        Installing
        ----------
        
        If you use the Anaconda Python Distribution, you can install this plugin
        with:
        
        ::
        
            conda install -c glueviz glue-vispy-viewers
        
        To install the latest stable version of the plugin, you can do:
        
        ::
        
            pip install glue-vispy-viewers
        
        or you can install the latest developer version from the git repository
        using:
        
        ::
        
            pip install https://github.com/glue-viz/glue-3d-viewer/archive/master.zip
        
        This will auto-register the plugin with Glue. Now simply start up Glue,
        open a data cube, drag it onto the main canvas, then select '3D viewer'.
        
        Testing
        -------
        
        To run the tests, do:
        
        ::
        
            py.test glue_vispy_viewers
        
        at the root of the repository. This requires the
        `pytest <http://pytest.org>`__ module to be installed.
        
        Using the isosurface viewer
        ---------------------------
        
        The isosurface viewer is currently still unstable - to enable it, put
        the following in a file called ``config.py`` file in your current
        working directory:
        
        ::
        
            from glue_vispy_viewers.isosurface import setup as setup_isosurface
            setup_isosurface()
        
        .. |Travis Status| image:: https://travis-ci.org/glue-viz/glue-vispy-viewers.svg
           :target: https://travis-ci.org/glue-viz/glue-vispy-viewers?branch=master
        .. |AppVeyor Status| image:: https://ci.appveyor.com/api/projects/status/7h9js5tdu9v9nnlg/branch/master?svg=true
           :target: https://ci.appveyor.com/project/glue-viz/glue-3d-viewer/branch/master
        .. |Coverage Status| image:: https://coveralls.io/repos/github/glue-viz/glue-vispy-viewers/badge.svg
           :target: https://coveralls.io/github/glue-viz/glue-vispy-viewers
        
Platform: UNKNOWN
