Skip to main content

ARPES data analysis and visualization tool

Project description

ARpest

Angle-Resolved Photoemission Electron Spectroscopy Tool

A modern, interactive Python application for analysing ARPES (Angle-Resolved Photoemission Spectroscopy) data from multiple synchrotron beamlines.

Python PyQt5 License

Features

Core Capabilities

  • Multi-beamline support: Load data from Diamond Light Source (I05) and MAX IV (Bloch)
  • Multiple file formats: .nxs, .h5, .zip, .ibw
  • 2D & 3D visualisation: Single cuts and photon energy/deflector angle scans
  • Interactive analysis: Real-time cursor tracking with live EDC/MDC updates
  • State management: Undo/redo functionality with complete processing history
  • Tabbed interface: Work with multiple datasets simultaneously
  • Save dataset: Save and comeback where you where

Performance

  • Optimized rendering for smooth visualisation
  • Fast numpy slicing for data extraction
  • In-place data updates (no memory reallocation)
  • Efficient rendering for large datasets

Installation

Requirements

  • Python 3.9 or higher
  • PyQt5
  • NumPy
  • SciPy
  • h5py
  • igor (optional, for .ibw files)
  • pyqtgraph

Quick Install

# Clone the repository
git clone https://github.com/OlaKenji/ARpest.git
cd arpest

# Install dependencies
pip install PyQt5 numpy matplotlib scipy h5py igor, pyqtgraph

# Run the application
python run.py

Usage

Basic Workflow

  1. Launch the application:

    python run.py
    
  2. Load data:

    • Click the 📂 Open File button in the toolbar
    • Select your ARPES data file (.nxs, .h5, .zip, or .ibw)
  3. Interactive analysis:

    • Apply data processing: Convert to k-space, correct the Fermi level based on a reference measurent and more
    • Click & drag: Continuously update cuts in real-time
    • 3D data: Use energy slider to navigate through different energy slices
  4. Configure settings:

    • Click ⚙️ Settings to set default data directory
    • Choose preferred colormap
    • Settings persist between sessions

Supported Beamlines

Diamond Light Source - I05

MAX IV - Bloch

Roadmap

  • Additional beamline support (SLS, SOLEIL, etc.)
  • Additional Data processing operations
  • Export processed data
  • Analysis plugins system

Contributing

Contributions are welcome! Please:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.


Citation

If you use ARpest in your research, please cite:

@software{arpest2025,
  author = {Ola Kenji Forslund},
  title = {ARpest: Interactive ARPES Data Analysis Tool},
  year = {2025},
  url = {https://github.com/OlaKenji/arpest}
}

Screenshots

2D Single Cut Analysis

2D Analysis Interactive band structure visualization with EDC and MDC

3D Fermi Surface Mapping

3D Analysis Fermi surface with momentum cuts


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

arpest-1.0.0.tar.gz (55.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

arpest-1.0.0-py3-none-any.whl (70.0 kB view details)

Uploaded Python 3

File details

Details for the file arpest-1.0.0.tar.gz.

File metadata

  • Download URL: arpest-1.0.0.tar.gz
  • Upload date:
  • Size: 55.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.13

File hashes

Hashes for arpest-1.0.0.tar.gz
Algorithm Hash digest
SHA256 8816c0bd4addcd0c751dc17f8e91c5d39242c80eb53d9fee7c2fc762239b1dfe
MD5 c0ca70de5b0a7dd36aae5090b9399732
BLAKE2b-256 fcf16412a5005129ffcb269fe30e6f67f88617a889f6df070abb77fea5e9c26f

See more details on using hashes here.

File details

Details for the file arpest-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: arpest-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 70.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.13

File hashes

Hashes for arpest-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 499018d26671108cf34b8165daa0a288445ee1b860c90214ebb3764888dffcdf
MD5 8a0ee01520c0fdea671b54d430ec4594
BLAKE2b-256 15230e0499aab10ce311d2efe54a1a66b667e410cb12c5b7c67ebd26acf1bac7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page