Documentation

PyARPES corrected (V5)

---

PyARPES simplifies the analysis and collection of angle-resolved photoemission spectroscopy (ARPES) and emphasizes

• modern, best practices for data science
• support for a standard library of ARPES analysis tools mirroring those available in Igor Pro
• interactive and extensible analysis tools, which is not used Qt related libraries. (All analysis is closed in Jupyter/marimo environment.)

It supports a variety of data formats from synchrotron and laser-ARPES sources including ARPES at the Advanced Light Source (ALS), the data produced by Scienta Omicron GmbH's "SES Wrapper", data and experiment files from Igor Pro, NeXuS files, and others.

To learn more about installing and using PyARPES in your analysis or data collection application, visit the documentation site.

PyARPES was originally developed by Conrad Stansbury of the Lanzara Group at the University of California, Berkeley.

This release introduces extensive refactoring and feature development aimed at long-term maintainability and usability. A major focus has been on reducing global state by introducing a centralized ConfigManager, modularizing the UI with Holoviews-based interactive apps, and deprecating unused or ambiguous components. Functionality has been restructured to align better with modern Python tools and community practices (e.g., xarray-lmfit instead of custom model broadcasting). Version 5 drops several legacy methods and models, simplifies internal APIs, and favors explicitness and modularity.

All Qt-based functionality has been completely removed. Instead, a new UI framework based on Holoviews and Panel is provided. This not only offers compatibility with the previous interactive tools but also enables fully self-contained analysis workflows within modern environments like JupyterLab or Marimo. Compared to seemingly elegant but brittle Qt applications, this approach yields a far more robust, reproducible, and user-friendly experience, especially for data analysis in collaborative and publication-ready settings.

This update is not backward compatible in many places, but provides a cleaner, more maintainable foundation for further development and real ARPES data analysis.

Citing PyARPES

If you use PyARPES in your work, please support the development of scientific software by acknowledging its usefulness to you with a citation. The simplest way to do this is to cite the paper describing the package in SoftwareX

@article{

stansburypyarpes, title = {PyARPES: An analysis framework for multimodal angle-resolved photoemission spectroscopies}, journal = {SoftwareX}, volume = {11}, pages = {100472}, year = {2020}, issn = {2352-7110}, doi = {https://doi.org/10.1016/j.softx.2020.100472}, url = {https://www.sciencedirect.com/science/article/pii/S2352711019301633}, author = {Conrad Stansbury and Alessandra Lanzara}, keywords = {ARPES, NanoARPES, Pump-probe ARPES, Photoemission, Python, Qt, Jupyter}, abstract = {},

}

And, if you have used the revised version of PyARPES, please cite the following paper:

@article{yg4g-x51r,

title = {Probing moir'e Bloch bands of photoexcited electrons on graphene/Ir(111)}, author = {Arafune, Ryuichi and Ishida, Hiroshi and Lin, Chun-Liang and Takagi, Noriaki}, journal = {Phys. Rev. B}, volume = {112}, issue = {16}, pages = {L161408}, numpages = {6}, year = {2025}, month = {Oct}, publisher = {American Physical Society}, doi = {10.1103/yg4g-x51r}, url = {https://link.aps.org/doi/10.1103/yg4g-x51r}

}

Installation

PyARPES (>= V.4.0) is installed from source. Python version 3.11 or newer is strongly recommmended.

The current version has been largely revised from the original version which are in PyPI and conda site. Unfortunately, I don't have the right the upload the current version to these site, and I have not taken it over from the original author. (I have tried it to send PR to the original author.).

The main purpose of revision of the package is to make this be reliable for us. Actually, the original version outputs the wrong results in many case, especially for angle-momentum conversion.

Thus, the current package can be installed only through the github.

Pip installation

pip install git+http://github.com/arafune/arpes

Local installation from source

If you want to modify the source for PyARPES as you use it, you might prefer a local installation from source. Details can be found on the documentation site.

Suggested steps

1. Install uv
2. Clone or duplicate the folder structure in this repository by git clone https://github.com/arafune/arpes.git
3. In the arpes directory, make the virtual environment, and activate it. The way of activation depends on your shell (bash, fish, zsh, powershell, etc.).
4. uv sync in arpes directory

Contact

Very unfortunately, we cannot get any responses from the original author. The comment below does not make sense at present.

Questions, difficulties, and suggestions can be directed to Conrad Stansbury (chstan@berkeley.edu) or added to the repository as an issue. In the case of trouble, also check the FAQ.

Copyright

Copyright © 2018-2019 by Conrad Stansbury, all rights reserved.

PyArpes contribution after cadaaae, © 2023-2025 by Ryuichi Arafune, all rights reserved.