Metadata-Version: 2.1
Name: arpespythontools
Version: 0.6.1
Summary: Explore, analyze, visualize Angle Resolved Photoemission Spectroscopy (ARPES) data.
Home-page: https://pranabdas.github.io/arpespythontools/
License: MIT
Keywords: python,data-analysis,matplotlib,materials-science,surface-science,condensed-matter-physics,photoelectron-spectroscopy,arpes
Author: Pranab Das
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: astropy (>=5.2.2,<6.0.0)
Requires-Dist: matplotlib (>=3.7.5,<4.0.0)
Requires-Dist: numpy (>=1.24.4,<2.0.0)
Requires-Dist: scipy (>=1.9.3,<2.0.0)
Project-URL: Documentation, https://pranabdas.github.io/arpespythontools/docs/
Project-URL: Repository, https://github.com/pranabdas/arpespythontools
Description-Content-Type: text/markdown

<h1 align="center">ARPES Python Tools</h1>

<p align="center">
  <a href="https://github.com/pranabdas/arpespythontools/actions/workflows/python-tests.yml"><img src="https://github.com/pranabdas/arpespythontools/actions/workflows/python-tests.yml/badge.svg" alt="Python tests status"></a>
  <a href="https://github.com/pranabdas/arpespythontools/actions/workflows/deploy-gh-pages.yml"><img src="https://github.com/pranabdas/arpespythontools/actions/workflows/deploy-gh-pages.yml/badge.svg" alt="Deploy gh-pages status"></a>
  <a href="https://github.com/pranabdas/arpespythontools/blob/master/LICENSE"><img src="https://img.shields.io/github/license/sourcerer-io/hall-of-fame.svg?colorB=A31F34"></a>
  <a href="https://github.com/pranabdas/arpespythontools/releases/latest"><img src="https://img.shields.io/github/v/release/pranabdas/arpespythontools.svg" alt="Latest Release"/></a>
</p>

This python library helps you load, analyze and visualize ARPES data.

## Quick start

Clone or [download](https://github.com/pranabdas/arpespythontools/releases) the
repository:
```console
git clone https://github.com/pranabdas/arpespythontools.git
```

Include path of parent `arpespythontools` folder (not required if you place it
under your working directory) and `import` in your program:

```python
import sys
sys.path.append("/parent/arpespythontools/path/")
import arpespythontools as arp
```

Use the modules:

```python
data, energy, angle = arp.load_ses_spectra("sample_spectrum.txt")
data_k, e_bin, k = arp.k_conv(data, energy, angle, 16.67)
```

Please find the detailed documentation here:
<https://pranabdas.github.io/arpespythontools/>

## Development
Run tests locally:
```python
python3 -m unittest tests.py
```

