Metadata-Version: 2.1
Name: hyperspyUI
Version: 1.1.3
Summary: Hyperspy Graphical User Interface
Home-page: http://github.com/hyperspy/hyperspyUI/
Author: Vidar Tonaas Fauske
Author-email: vidartf+hyperspyui@gmail.com
License: GPLv3
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Environment :: MacOS X
Classifier: Environment :: Win32 (MS Windows)
Classifier: Environment :: X11 Applications :: Qt
Classifier: Development Status :: 4 - Beta
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
Description-Content-Type: text/x-rst
Requires-Dist: hyperspy (>=1.4.1)
Requires-Dist: hyperspy-gui-traitsui (>=1.1.1)
Requires-Dist: matplotlib (>=1.3)
Requires-Dist: pyqode.python (>=2.6.0)
Requires-Dist: pyface (>=6.0.0)
Requires-Dist: autopep8
Requires-Dist: traits
Requires-Dist: traitsui (>=5.2.0)
Requires-Dist: qtconsole
Requires-Dist: ipykernel (>=5.2.0)
Requires-Dist: qtpy
Requires-Dist: pywin32 ; sys_platform == "win32"
Provides-Extra: tests
Requires-Dist: pytest-qt ; extra == 'tests'
Requires-Dist: pytest-cov ; extra == 'tests'
Requires-Dist: pytest-timeout ; extra == 'tests'

HyperSpyUI
==========

|pypi_version|_ |anaconda_cloud|_ |tests|_ |python_version|_

.. |pypi_version| image:: http://img.shields.io/pypi/v/hyperspyui.svg
.. _pypi_version: https://pypi.python.org/pypi/hyperspyui

.. |anaconda_cloud| image:: https://anaconda.org/conda-forge/hyperspyui/badges/version.svg
.. _anaconda_cloud: https://anaconda.org/conda-forge/hyperspyui

.. |tests| image:: https://github.com/hyperspy/hyperspyUI/workflows/Tests/badge.svg
.. _tests: https://github.com/hyperspy/hyperspyUI/actions

.. |python_version| image:: https://img.shields.io/pypi/pyversions/hyperspyui.svg?style=flat
.. _python_version: https://pypi.python.org/pypi/hyperspyui

HyperSpyUI tries to bring a streamlined user interface to the powerful
multi-dimensional analysis capabilities of HyperSpy_. HyperSpy is an open
source Python library which provides tools to facilitate data analysis of
multidimensional datasets.

HyperSpy aims at making it easy and natural to apply analytical procedures
that operate on an individual signal to multidimensional arrays, as well as
providing easy access to analytical tools that exploit the multidimensionality
of the dataset.

While the UI tries to create a simple and intuitive interface to HyperSpy, it
still retains the raw power of HyperSpy via the UIâ€™s built in IPython console,
which runs on the same Python kernel as the UI.

Documentation
=============

For an introduction to HyperSpyUI, see the documentation_.


Installation
============
There are several ways to install HyperSpyUI. The application itself is rather
simple to install, but its dependencies can be a bit more tricky. From version 
1.1, HyperSpyUI supports both PyQt4 and PyQt5.

Bundle Installer on Windows
---------------------------
If you're on Windows, the quickest way to get set up is to download and install
the `HyperSpy bundle`_ installer, which includes HyperSpyUI.

.. _HyperSpy bundle: https://github.com/hyperspy/hyperspy-bundle

Anaconda/Miniconda on Mac or Linux
----------------------------------

Download and install the `Miniconda`_ or `Anaconda`_ distribution and run the following command 
in the anaconda prompt: 

.. code-block:: bash

    conda install -c conda-forge hyperspyui

.. _Miniconda: https://docs.conda.io/en/latest/miniconda.html
.. _Anaconda: https://www.anaconda.com/products/individual

Installation via pip
--------------------

HyperSpyUI can be intall from pip. Depending on your python distribution you may 
need to have C compiler on your system to install some of the dependencies.

.. code-block:: bash

    pip install hyperspyui

If pyqt is not installed, run:

.. code-block:: bash

    pip install PyQt5 PyQtWebEngine


Run HyperSpyUI
==============

After installation, you can run HyperSpyUI from the command prompt with:

.. code-block:: bash

    hyperspyui

or 

.. code-block:: bash

    python -m hyperspyui


For further information, see the full documentation_.

.. _HyperSpy: http://hyperspy.org
.. _documentation: http://hyperspy.org/hyperspyUI/


