Metadata-Version: 2.0
Name: hyperspy-gui-traitsui
Version: 1.0.1
Summary: traitsui GUI elements for HyperSpy.
Home-page: https://github.com/hyperspy/hyperspy_gui_traitsui
Author: The HyperSpy Developers
Author-email: devel@hyperspy.org
License: GPLv3
Keywords: hyperspy traitsui
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Dist: hyperspy (>=1.3)
Requires-Dist: traitsui (>=5.0)

hyperspy\_gui\_traitsui
=======================

|Build Status|

**hyperspy\_gui\_traitsui** provides traitsui graphic user interface
(GUI) elements for hyperspy.

Installation
------------

Option 1: With pip
==================

Make sure you have `pip
installed <https://pip.pypa.io/en/stable/installing/>`__ and run:

.. code:: bash

    pip install hyperspy_gui_traitsui

Option 2: With Anaconda
=======================

Install anaconda for your platform and run

.. code:: bash

    conda install hyperspy_gui_traitsui -c conda-forge

traitsui doesn't support Qt5 as of version 5.1. Therefore, when using
the Qt toolkit it may be necessary to downgrade pyqt, which requires
removing the anaconda-navigator package as follows:

.. code:: bash


    conda uninstall anaconda-navigator -y
    conda install pyqt=4.11.4 -y

Usage
-----

Please refer to the `HyperSpy
documentation <http://hyperspy.org/hyperspy-doc/current/index.html>`__
for details. Example (to run in any IPython flavour):

.. code:: python

    %matplotlib qt4
    import hyperspy.api as hs
    hs.preferences.gui(toolkit="traitsui")

.. figure:: https://github.com/hyperspy/hyperspy_gui_traitsui/raw/master/images/preferences_gui.png
   :alt: HyperSpy preferences ipywidget

   alt text

Development
-----------

Contributions through pull requests are welcome. See the `HyperSpy
Developer
Guide <http://hyperspy.org/hyperspy-doc/current/dev_guide.html>`__.

.. |Build Status| image:: https://travis-ci.org/hyperspy/hyperspy_gui_traitsui.svg?branch=master
   :target: https://travis-ci.org/hyperspy/hyperspy_gui_traitsui


