Installation#

hdf5view is designed to work on Windows, macOS and Linux. Python >= 3.6 is required and, in addition to installing hdf5view, you will need to install one of the available Qt API Bindings.

hdf5view#

To install the current release of hdf5view from PyPI using pip, enter the following command in the terminal:

pip install hdf5view

Alternatively, to install hdf5view from source, clone the repository from GitHub and install with pip:

git clone https://github.com/tgwoodcock/hdf5view.git
cd hdf5view
pip install .

Note

If you would like to contribute to hdf5view, please have a look at the Contributing guide for instructions on Installing a Development Environment.

Qt API Bindings#

One of pyqt5, pyside2, pyqt6 or pyside6 is required in order to be able to run hdf5view. Please install any one of these. For instance, to install pyqt5 with pip:

pip install pyqt5

Note

pyside2 is not compatible with Python 3.12

Note

hdf5view uses qtpy as an abstraction layer for pyqt5/pyside2/pyqt6/pyside6. If you have any of these Qt API bindings installed, qtpy will take the first available one in the order shown in the previous sentence. hdf5view works with all of the bindings.

Tip

If you have more than one of the bindings installed and want to specify which one should be used for hdf5view, you can do this by setting the QT_API environment variable before running hdf5view. For example: if you have pyqt5 and pyside2 installed and you want hdf5view to use PySide2, on Windows PowerShell:

$env:QT_API = 'pyside2'

or on linux (Ubuntu/Debian):

export QT_API=pyside2

Other Dependencies#

The other dependencies required by hdf5view (qtpy, h5py, psutil and pyqtgraph) will be installed automatically during the installation of hdf5view, if they are not already present on your system. Currently installed versions of these dependencies will not be overwritten by installing hdf5view.

Note

pyqtgraph 0.12 supports all of pyqt5, pyside2, pyqt6 or pyside6. Older versions of pyqtgraph may not support all of them.

To uninstall hdf5view:#

pip uninstall hdf5view