Metadata-Version: 2.4
Name: pyleem
Version: 0.2.1
Summary: Low Energy Electron Microscopy data analysis toolkit
Author-email: Peter Sun <hs859@cornell.edu>
Maintainer-email: Peter Sun <hs859@cornell.edu>
License-Expression: BSD-3-Clause
Project-URL: Repository, https://github.com/peterhys/PyLEEM
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
License-File: THIRD_PARTY_LICENSES
Requires-Dist: numpy>=2
Requires-Dist: scikit-image>=0.24.0
Requires-Dist: matplotlib>=3.9.0
Requires-Dist: roifile==2026.2.10
Requires-Dist: lmfit>=1.3.2
Requires-Dist: opencv-python>=4.12.0
Requires-Dist: tomlkit>=0.12
Requires-Dist: scipy>=1.17.0
Provides-Extra: test
Requires-Dist: pytest>=9.0.2; extra == "test"
Requires-Dist: pytest-cov>=7.0.0; extra == "test"
Requires-Dist: coverage>=7.13.4; extra == "test"
Provides-Extra: docs
Requires-Dist: sphinx>=9.0.4; extra == "docs"
Requires-Dist: sphinx-book-theme>=1.1.4; extra == "docs"
Requires-Dist: myst-parser; extra == "docs"
Dynamic: license-file

# pyLEEM

[![License: BSD 3-Clause](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](LICENSE)
[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
[![Tests](https://github.com/peterhys/PyLEEM/actions/workflows/tests.yml/badge.svg)](https://github.com/peterhys/PyLEEM/actions/workflows/tests.yml)

A Python toolkit for analyzing Low Energy Electron Microscopy (LEEM) data. 
pyLEEM provides tools for reading LEEM files, performing XPS, SEES, and LEED analysis, and stitch profiles.

## Installation

```bash
pip install pyleem
```

## Development installation

Clone the development branch:

```bash
git clone --branch develop https://github.com/peterhys/PyLEEM.git
cd PyLEEM
pip install -e .
```

## Documentation

- [Changelog](CHANGELOG.md)
- [Contributing](CONTRIBUTING.md)

## License

pyLEEM is distributed under the BSD 3-Clause License, see [LICENSE](LICENSE).

Additional Brookhaven National Laboratory, U.S. Department of Energy, and U.S.
Government rights notices are provided in [NOTICE](NOTICE).

Third-party dependencies are distributed under their own licenses, see
[THIRD_PARTY_LICENSES](THIRD_PARTY_LICENSES).
