xrheed 0.5.13

An xarray-based toolkit for RHEED image analysis

xRHEED

📡 An xarray-based toolkit for RHEED image analysis.

---

---

🔬 What is RHEED?

Reflection High-Energy Electron Diffraction (RHEED) is an experimental technique used to monitor and control the quality of crystal surfaces.
A high-energy electron beam (∼20 keV) strikes the surface at a grazing angle (< 5°), making the method highly surface-sensitive and probing only a few atomic layers.

---

🎯 Project Goals

xRHEED provides a flexible and extensible Python toolkit for RHEED image analysis:

• 🖼️ Load and preprocess RHEED images
• 📈 Generate and analyze intensity profiles
• ✨ Overlay predicted diffraction spot positions (kinematic theory & Ewald construction)
• 🔄 Transform RHEED images into kx–ky space
• 🔍 Search for reconstruction lattice constants and rotations by calculating the matching coefficient between predicted and experimental data

👉 Note: xRHEED is not a GUI application. It is designed as an xarray accessory library, intended for use in interactive environments such as Jupyter notebooks.

---

⚡ Installation

You can install xRHEED using either uv or pip.

Using pip (editable install for development)

git clone https://github.com/mkopciuszynski/xrheed
cd xrheed
pip install -e .

Using uv (with a virtual environment)

1. Install uv.
2. Clone the repository:

   git clone https://github.com/mkopciuszynski/xrheed
   cd xrheed
   

3. Create and activate a virtual environment (depending on your shell: bash, zsh, fish, PowerShell).
4. Sync dependencies:

   uv sync
   

---

🚀 Quick Usage

import matplotlib.pyplot as plt
import xrheed
from xrheed.io import load_data

# Load a RHEED image
rheed_image = load_data("rheed_image.raw", plugin="dsnp_arpes_raw")

# Show image with auto-adjusted levels
rheed_image.ri.plot_image(auto_levels=2.0)
plt.show()

# Get intensity profile and plot its origin
profile = rheed_image.ri.get_profile(center=(0, -5), width=40, height=4,
                                     plot_origin=True)

---

📖 Citation

If you use xRHEED in your research, please consider citing this repository:

Kopciuszynski, M. (2025). xRHEED: An xarray-based toolkit for RHEED image analysis. GitHub. https://github.com/mkopciuszynski/xrheed

📌 A formal DOI will be provided in the future via Zenodo.

---

📚 👉 See the full documentation for tutorials and advanced examples.