PIVA: Photoemission Interface for Visualization and Analysis
PIVA: Photoemission Interface for Visualization and Analysis - Published in JOSS (2025)
Science Score: 95.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 10 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org, zenodo.org -
✓Committers with academic emails
1 of 6 committers (16.7%) from academic institutions -
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Keywords
Repository
Interactive tools for the visualization and analysis of multidimensional photoemission data
Basic Info
- Host: GitHub
- Owner: pudeIko
- License: mit
- Language: Python
- Default Branch: main
- Homepage: https://piva.readthedocs.io/en/latest/intro.html
- Size: 305 MB
Statistics
- Stars: 8
- Watchers: 1
- Forks: 3
- Open Issues: 7
- Releases: 2
Topics
Metadata Files
README.md
Photoemission Interface for Visualization and Analysis
PIVA is a graphical user interface (GUI) application built with PyQt5 and
pyqtgraph toolkits, designed for the interactive and intuitive examination
of large image-like datasets. While it can display any multidimensional data,
most of its functionalities are specifically tailored for users conducting
Angle-Resolved Photoemission Spectroscopy (ARPES) experiments.
Its primary objective is to improve the efficiency of ARPES data inspection and analysis by providing interactive, intuitive tools designed to handle large, multidimensional datasets. For more information and a comparison with other packages commonly used in the ARPES community, please refer to the Statement of need section of the accompanying manuscript.
A variety of standard methods and image processing algorithms are available directly from the GUI. Additionally, several utilities are particularly useful during the experimental phase when decisions about subsequent steps need to be made quickly. These utilities include automated methods for locating the highest symmetry points, azimuthal rotation, and autogenerated experimental notebooks. These features are implemented for various beamlines at different synchrotron sources around the world.
Installation
The installation of PIVA has been tested on macOS, Windows and Linux.
The easiest way to install the package is to use pip. Just type the following
on a command line:
bash
pip install piva
Alternatively, you can install the package directly from the source:
bash
git clone https://github.com/pudeIko/piva.git
cd piva
conda env create -f environment.yml
This will automatically set up the virtual environment and install the package in editable mode.
Documentation
The showcase above highlights the general usage and capabilities of the package. For more detailed information and examples, visit the project's documentation website, including:
- Getting Started, to learn more about installation, opening example datasets, and running automated tests,
- GUI Applications, to explore the layout and functionalities of the interactive viewers, and
- Data Handling, to discover the supported file types and how PIVA manages data harmonization.
Citing
If you use the PIVA package in your research/project, please acknowledge it by citing the manuscript that describes the software:
Pudelko et al., PIVA: Photoemission Interface for Visualization and Analysis. Journal of Open Source Software, 10(114), 9129 (2025). https://doi.org/10.21105/joss.09129
@article{Pudelko2025,
author = {Pudelko, Wojciech R. and Kramer, Kevin and Kspert, Julia and Chang, Johan and Plumb, Nicholas C.},
title = {PIVA: Photoemission Interface for Visualization and Analysis},
journal = {Journal of Open Source Software},
year = {2025},
volume = {10},
number = {114},
pages = {9129},
doi = {10.21105/joss.09129}
}
Owner
- Name: Wojtek Pudelko
- Login: pudeIko
- Kind: user
- Location: Zürich, Switzerland
- Company: University of Zürich
- Repositories: 2
- Profile: https://github.com/pudeIko
JOSS Publication
PIVA: Photoemission Interface for Visualization and Analysis
Authors
Swiss Light Source, Paul Scherrer Institut, Forschungstrasse 111, CH-5232 Villigen PSI, Switzerland, Physik Institut, Universität Zürich, Winterthurerstrasse 190, CH-8057 Zürich, Switzerland
Physik Institut, Universität Zürich, Winterthurerstrasse 190, CH-8057 Zürich, Switzerland
Physik Institut, Universität Zürich, Winterthurerstrasse 190, CH-8057 Zürich, Switzerland
Physik Institut, Universität Zürich, Winterthurerstrasse 190, CH-8057 Zürich, Switzerland
Swiss Light Source, Paul Scherrer Institut, Forschungstrasse 111, CH-5232 Villigen PSI, Switzerland
Editor
Kyle Niemeyer
Tags
Angle-resolved photoemission spectroscopy Experimental physics Data visualization Data analysisGitHub Events
Total
- Create event: 9
- Release event: 2
- Issues event: 4
- Watch event: 10
- Delete event: 3
- Issue comment event: 6
- Push event: 113
- Pull request event: 22
- Fork event: 1
Last Year
- Create event: 9
- Release event: 2
- Issues event: 4
- Watch event: 10
- Delete event: 3
- Issue comment event: 6
- Push event: 113
- Pull request event: 22
- Fork event: 1
Committers
Last synced: 3 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| pudelko | w****o@g****m | 217 |
| Kevin Kramer | k****r@p****e | 44 |
| Kevin Kramer | k****r@p****h | 8 |
| Wojciech Pudełko | k****e@M****l | 2 |
| jukue | 1****e@u****m | 2 |
| pudeIko | w****o@c****l | 2 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 4 months ago
All Time
- Total issues: 48
- Total pull requests: 21
- Average time to close issues: 3 months
- Average time to close pull requests: about 5 hours
- Total issue authors: 3
- Total pull request authors: 3
- Average comments per issue: 1.29
- Average comments per pull request: 0.57
- Merged pull requests: 20
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 5
- Pull requests: 15
- Average time to close issues: N/A
- Average time to close pull requests: about 1 hour
- Issue authors: 2
- Pull request authors: 2
- Average comments per issue: 0.0
- Average comments per pull request: 0.6
- Merged pull requests: 14
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- kuadrat (29)
- pudeIko (16)
- lesslogic (4)
Pull Request Authors
- pudeIko (17)
- kuadrat (6)
- jukue (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 145 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 29
- Total maintainers: 1
pypi.org: piva
PIVA - Photoemission Interface for Visualization and Analysis
- Homepage: https://github.com/pudeIko/piva.git
- Documentation: https://piva.readthedocs.io/en/latest/intro.html
- License: MIT License
-
Latest release: 3.0.0
published 5 months ago
Rankings
Maintainers (1)
Dependencies
- sphinx *
- sphinx_rtd_theme *
- astropy >=4.2
- data_slicer >=1.0.2
- h5py >=3.1.0
- igor >=0.3
- ipywidgets >=7.6.3
- julia >=0.5.6
- jupyterthemes >=0.20.0
- matplotlib >=3.3.4
- notebook >=6.4
- numba >=0.53.1
- numpy >=1.21.1
- openpyxl >=3.0.9
- pandas >=1.3.5
- pyqt5 >=5.15.0
- pyqtgraph >=0.13.1
- scipy >=1.6.0
- tqdm >=4.56.0