Metadata-Version: 2.1
Name: py4D_browser
Version: 0.999995
Summary: A 4D-STEM data browser built on py4DSTEM.
Author-email: Steven Zeltmann <steven.zeltmann@lbl.gov>
Project-URL: Homepage, https://github.com/py4dstem/py4D-browser
Project-URL: Bug Tracker, https://github.com/py4dstem/py4D-browser/issues
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: py4dstem>=0.14.3
Requires-Dist: emdfile>=0.0.11
Requires-Dist: h5py
Requires-Dist: numpy>=1.19
Requires-Dist: matplotlib>=3.2.2
Requires-Dist: PyQt5>=5.10
Requires-Dist: pyqtgraph>=0.11


# The `py4DSTEM` GUI

This repository hosts the `pyqt` based graphical 4D--STEM data browser that was originally part of **py4DSTEM** until version 0.13.11. 

## Installation 
The GUI is available on PyPI and conda-forge: 

`pip install py4D-browser`

`conda install -c conda-forge py4d-browser`


## Usage
Run `py4DGUI` in your terminal to open the GUI. Then just drag and drop a 4D-STEM dataset into the window!

![Demonstration](/images/demo.gif)

## About 

![py4DSTEM logo](/images/py4DSTEM_logo.png)

**py4DSTEM** is an open source set of python tools for processing and analysis of four-dimensional scanning transmission electron microscopy (4D-STEM) data. Additional information:

- [Our open access py4DSTEM publication in Microscopy and Microanalysis](https://doi.org/10.1017/S1431927621000477) describing this project and demonstrating a variety of applications.
- [The py4DSTEM documentation pages](https://py4dstem.readthedocs.io/en/latest/index.html).
- [Our open access 4D-STEM review in Microscopy and Microanalysis](https://doi.org/10.1017/S1431927619000497) describing this project and demonstrating a variety of applications.


### License

GNU GPLv3

**py4DSTEM** is open source software distributed under a GPLv3 license.
It is free to use, alter, or build on, provided that any work derived from **py4DSTEM** is also kept free and open.
