Skip to main content

ARPES data analysis and visualization tool

Project description

ARpest

Angle Resolved Photoemission Electron Spectroscopy Tool

A modern, interactive GUI application for analysing ARPES (Angle-Resolved Photoemission Spectroscopy) data from multiple synchrotron beamlines. Coding or scripting is not needed.

Python PyQt5 License

Features

Core Capabilities

  • Multi-beamline support: Load data from Diamond Light Source (I05) and MAX IV (Bloch)
  • Multiple file formats: .nxs, .zip, .ibw
  • 2D, 3D & 4D visualisation: Single cuts and photon energy/deflector angle scans
  • Interactive visualisation: Real-time cursor tracking with live EDC/MDC updates
  • Proces the data: Convert to k-space, correct the Fermi level based on a reference measurent etc.
  • State management: Undo/redo functionality with complete processing history
  • Analyse the data: Fit the process data
  • 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

🎥 Live Demo

Watch real-time interaction with a 3D ARPES dataset: ➡️ https://github.com/OlaKenji/ARpest/wiki/Live-Demo


Installation

Requirements

  • Python 3.7 or higher
  • PyQt5
  • NumPy
  • SciPy
  • h5py
  • igor
  • matplotlib
  • pyqtgraph

Quick Install

# Install ARpest from PyPI
pip install arpest

# Launch the GUI
arpest

Usage

Basic Workflow

  1. Launch the application:

    arpest
    
  2. Configure settings:

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

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

    • Click & drag: Continuously update cuts in real-time
    • 3D data: Use energy slider to navigate through different energy slices
  5. Analyse and process the data:

    • Apply data processing: Convert to k-space, correct the Fermi level based on a reference measurent and more
    • Analyse by fitting the processed data: Fit EDC/MDC curves

Supported Beamlines

Diamond Light Source - I05

MAX IV - Bloch

Roadmap

  • Additional beamline support (SLS, SOLEIL, etc.)
  • Additional analysis methods

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.


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

3D Fermi Surface Mapping

3D Analysis

Fermi surface with momentum cuts. Data from Phys. Rev. Lett. 134, 126602 (https://doi.org/10.1103/PhysRevLett.134.126602).


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.4.tar.gz (103.4 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.4-py3-none-any.whl (135.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: arpest-1.0.4.tar.gz
  • Upload date:
  • Size: 103.4 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.4.tar.gz
Algorithm Hash digest
SHA256 2762cf791be0450d46ffc0724a6a25a8e575f4ef1564f8c1d365ff54b359cd1c
MD5 20b6d0ca553e3ff723ac8cfb9e6e15e2
BLAKE2b-256 45179e312d7522c74e2f493eef762bdc0622cf21df0f30b901c15fdcc04fee9a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: arpest-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 135.1 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b57b70f725c092270c97ec1b7c16b1da22963c25186a914f70bc9fda78c7630c
MD5 06ae51e189000f943a36b8a110a82c90
BLAKE2b-256 c58de8755b5b5f76e9222c25b6fb1b26d522d0f3b5e83bcb556ea512b9748016

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