Metadata-Version: 2.1
Name: piva
Version: 2.3.0a0
Summary: PIVA - Photoemission Interface for Visualization and Analysis
Home-page: https://github.com/pudeIko/piva.git
Author: Wojtek Pudelko
Author-email: wojciech.pudelko@psi.ch
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: astropy>=4.2
Requires-Dist: data_slicer>=1.0.2
Requires-Dist: h5py>=3.11.0
Requires-Dist: igor2>=0.5
Requires-Dist: ipywidgets>=7.6.3
Requires-Dist: julia>=0.5.6
Requires-Dist: jupyterlab>=3.5
Requires-Dist: jupyterthemes>=0.20.0
Requires-Dist: numpy<2.0.0
Requires-Dist: numba>=0.57.0
Requires-Dist: matplotlib>=3.3.4
Requires-Dist: openpyxl>=3.0.9
Requires-Dist: pandas>=1.3.5
Requires-Dist: pyqt5>=5.15.0
Requires-Dist: pyqtgraph>=0.13.1
Requires-Dist: scipy>=1.6.0
Requires-Dist: tqdm>=4.56.0
Requires-Dist: typing>=3.7

# PIVA - Photoemission Interface for Visualization and Analysis

![PyPI - Version](https://img.shields.io/pypi/v/piva)
[![Documentation Status](https://readthedocs.org/projects/piva/badge/?version=latest)](https://piva.readthedocs.io/en/latest/?badge=latest)
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![GitHub license](https://img.shields.io/github/license/pudeIko/piva)](https://github.com/ekiefl/pooltool/blob/master/LICENSE.txt)

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md)


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.

![](./docs/img/showcase.gif)

A variety of standard methods and image processing algorithms (such as 
momentum-space conversion, energy distribution curve symmetrization, and 
derivative analysis) 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
   ```

or directly from this repo:
   ```bash
   pip install git+https://github.com/pudeIko/piva.git
   ```


## Documentation 

More details on the installation and full description of the package can be 
found on the [documentation](https://piva.readthedocs.io/en/latest/) site.
