Metadata-Version: 2.4
Name: py4d-browser-edax
Version: 0.1.0
Summary: py4d-browser plugin for loading EDAX TSL UP1/UP2 EBSD pattern files
Author-email: Yu-Tsun Shao <yutsunsh@usc.edu>
License-Expression: MIT
Project-URL: Homepage, https://github.com/ys755/py4d-browser-edax
Project-URL: Bug Tracker, https://github.com/ys755/py4d-browser-edax/issues
Keywords: EBSD,EDAX,TSL,py4d-browser,electron microscopy
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: py4d-browser
Dynamic: license-file

# py4d-browser-edax

A [py4d-browser](https://github.com/py4dstem/py4d-browser) plugin for loading
EDAX TSL binary EBSD pattern files (`.up1` / `.up2`).

## Installation

```bash
pip install py4d-browser-edax
```

Requires py4d-browser to already be installed.

## Usage

Launch py4d-browser as usual:

```bash
py4DGUI
```

A new **"EDAX UP1/UP2..."** entry appears in the **Plugins** menu.
Click it, select your `.up1` or `.up2` file, and the dataset loads into the browser.

### File format support

| Feature | Support |
|---------|---------|
| `.up1` (8-bit uint patterns) | ✓ |
| `.up2` (16-bit uint patterns) | ✓ |
| Version 1 files (no embedded scan shape) | ✓ — prompts for rows × cols |
| Version ≥ 3 files (scan shape in header) | ✓ — automatic |
| Hex-grid scans | ✓ — loaded as 1-D navigation with warning |
| Scan step size (µm) from header | ✓ — set as R-space calibration |

### Version 1 files

Version 1 UP files do not store the scan dimensions in the header.
When you open one the plugin will ask you to enter the scan shape (rows, cols).
Leave the field blank to load all patterns as a flat 1-D stack.

## Development

```bash
git clone https://github.com/yu-tsun-shao/py4d-browser-edax
cd py4d-browser-edax
pip install -e .
```

## License

MIT © Yu-Tsun Shao
