Metadata-Version: 2.1
Name: hyperspy_gui_ipywidgets
Version: 1.2
Summary: ipywidgets GUI elements for HyperSpy.
Home-page: https://github.com/hyperspy/hyperspy_gui_ipywidgets
Author: The HyperSpy Developers
Author-email: devel@hyperspy.org
License: GPLv3
Description: hyperspy_gui_ipywidgets
        =======================
        
        |Build Status|
        
        **hyperspy_gui_ipywidgets** provides ipywidgets 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_ipywidgets
        
        Option 2: With Anaconda
        =======================
        
        Install anaconda for your platform and run
        
        .. code:: bash
        
           conda install hyperspy-gui-ipywidgets -c conda-forge
        
        Running the tests
        -----------------
        
        py.test is required to run the tests.
        
        .. code:: bash
        
           pip install "hyperspy_gui_ipywidgets[test]"
           py.test --pyargs hyperspy_gui_ipywidgets
        
        Usage
        -----
        
        Please refer to the `HyperSpy
        documentation <http://hyperspy.org/hyperspy-doc/current/index.html>`__
        for details. Example (to run in the `Jupyter
        Notebook <http://jupyter.org/>`__):
        
        .. code:: python
        
        
           import hyperspy.api as hs
           hs.preferences.gui(toolkit="ipywidgets")
        
        .. figure:: https://github.com/hyperspy/hyperspy_gui_ipywidgets/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_ipywidgets.svg?branch=master
           :target: https://travis-ci.org/hyperspy/hyperspy_gui_ipywidgets
        
Keywords: hyperspy ipywidgets
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
Provides-Extra: test
