Dual Space Crystallography Explorer (DuSC_explorer)

A graphical user interface based on stempy and pyqtgraph to visualize sparse 4D-STEM data sets.

Installation

Using pip

The easiest way to install is to use python's pip command:

• (Optional) Set up a virtual environment (e.g. using conda)
• Run the following command at a command prompt

pip install DuSC_explorer

• See the "compatibility" section below for installing QT bindings.

From source

If you want to develop or get the newest changes:

• Clone the repository using git.
• Change directories to the base directory containing the pyproject.toml file.
• Install locally and editable by running this in a terminal

pip install -e .

Tutorial

To get started with the program please see our tutorial. You can also download example data from a recently published paper from this Zenodo repository: .

Compatibility

This program requires pyqtgraph >=0.13. You may also need to install different versions of QT depending on your operating system. Python 3.9 and PyQt6 have been tested to work as specified in the table on the pyqtgaph Github README

Running the program

If you installed using pip or from source (see above) then you can simply type the program name in the command line and press enter:

$ DuSC_explorer

in a terminal or command prompt in the correct virtual environment and the GUI should start.

Alternatively, in a python interpreter for the correct environment you can run these commands to start the GUI:

>>> import DuSC_explorer
>>> DuSC_explorer.open_file()