hyperspy / hyperspyUI

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.

HyperSpy Bundle Installer

The quickest way to get set up is to download and install the HyperSpy bundle installer, which includes HyperSpyUI.

Anaconda/Miniconda/Miniforge

Download and install the Miniforge (Miniconda or Anaconda) distribution and run the following command in the anaconda prompt:

conda install -c conda-forge hyperspyui

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.

pip install hyperspyui

If pyqt is not installed, run:

pip install PyQt5 PyQtWebEngine

Run HyperSpyUI

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

hyperspyui

or

python -m hyperspyui

For further information, see the full documentation.