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.

Bundle Installer

If you’re on Windows, the quickest way to get set up is to download and install the HyperSpyUI bundle installer. The bundled WinPython distribution includes all the dependencies of the program, and the installer also helps create program shortucts and register common microscopy file formats with the application.

The bundle installer can also be used if you already have installed a WinPython distribution (e.g. via the HyperSpy bundle), and just want to add HyperSpyUI and its dependencies, although it might not support older versions.

Install via pip

HyperSpyUI is on PyPI, so simply running the command pip install hyperspyui should download and install HyperSpyUI and its dependencies. The package defines a GUI script hyperspyui, which can be called to start the application, or alternatively it can be started by running python -m hyperspyui.

To get HyperSpyUI to integrate with your operating system after installation, you can run the script hyperspyui_install.py. Currently, this only integrates with Windows, but this is intended to be extend to Linux systems in the future (please consider contributing).

Getting Qt

Getting and installing Qt might or might not be easy, depending on which operating system you are on. For this reason, it is recommended to run HyperSpyUI on a distribution which offers ready-made Qt packages. Examples include WinPython, Conda and Canopy.