Metadata-Version: 2.4
Name: plaid-xrd
Version: 0.0.8
Summary: plaid is a simple visualization tool intended to quickly evaluate azimuthally integrated powder diffraction data
Home-page: https://github.com/fgjorup/plaid
Author: Frederik H Gjørup
Author-email: fgjorup@chem.au.dk
License: GPL-3.0
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: h5py
Requires-Dist: PyQt6>=6.8.1
Requires-Dist: pyqtgraph>=0.13.7
Requires-Dist: Dans-Diffraction>=3.0.0
Requires-Dist: requests>=2.25.0
Requires-Dist: packaging>=20.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# plaid - plot azimuthally integrated data  
plaid is a simple visualization tool intended to quickly evaluate azimuthally integrated powder diffraction data and compare to known structures, provided by the user in the form of CIF files.  
The main data format is HDF5 files, inspired by the [NeXus](https://www.nexusformat.org/) file formats.  

## Installation  
Install plaid from the Python Package Index [PyPi](https://pypi.org/) with:  
`pip install plaid-xrd`

Start the application from a terminal with:  
`plaid`

## Example  
**The main window of plaid**  
- Drag/drop an .h5 file into the main window or browse from *File* -> *Open*  
- Change the pattern by moving the horizontal lines with the mouse or the arrow keys  
- Add a new moveable line by double-clicking the heatmap, remove a line by right-clicking it  
- Click the symbols in the pattern legend to show/hide the patterns  
- Drag/drop a .cif file into the main window or browse from *File* -> *Load CIF*  
- Click on a reference line to show its reflection index  

**File tree context menu**
- Right-click on a file in the file tree to add $I_0$ or auxiliary data  
- Right-click on two or more selected files to group them  

**Export patterns**
- Save the export settings in *Export -> Export settings*

## Hotkeys
| Key | Action                                      |
|-----|---------------------------------------------|
| L   | Toggle log scale for the heatmap            |
| Q   | Toggle between q and 2θ axes                |
| ↑   | Move the active line one frame up           |
| ↓   | Move the active line one frame down         |
| ←   | Move the active line several frames down    |
| →   | Move the active line several frames up      |
