Skip to content

Commit dad2ee2

Browse files
KedoKudoclaude
andcommitted
fix: add missing rustpix-gui README.md for maturin wheel build
The pyproject.toml referenced README.md but the file did not exist, causing maturin to fail on both Linux and macOS GUI wheel builds. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 60e0eb7 commit dad2ee2

1 file changed

Lines changed: 38 additions & 0 deletions

File tree

rustpix-gui/README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# rustpix-gui
2+
3+
GUI application for rustpix pixel detector processing.
4+
5+
## Installation
6+
7+
### macOS (Homebrew)
8+
9+
```bash
10+
brew tap ornlneutronimaging/rustpix
11+
brew install --cask rustpix
12+
```
13+
14+
### pip
15+
16+
```bash
17+
pip install rustpix-gui
18+
rustpix-gui
19+
```
20+
21+
### From Source
22+
23+
```bash
24+
cargo run --release -p rustpix-gui
25+
```
26+
27+
## Features
28+
29+
- Interactive file loading (open or drag-and-drop TPX3 files)
30+
- Real-time 2D detector map visualization
31+
- ABS, DBSCAN, and Grid clustering algorithms
32+
- Parameter tuning with immediate visual feedback
33+
- ROI selection for focused analysis
34+
- Export to HDF5 (NeXus), HDF5 (SNS NXsnsevent), TIFF, and CSV
35+
36+
## Documentation
37+
38+
See the [full documentation](https://ornlneutronimaging.github.io/rustpix/gui/).

0 commit comments

Comments
 (0)