Metadata-Version: 2.4
Name: pynxtools-mpes
Version: 0.2.8
Author: The NOMAD Authors
License: Apache-2.0
Project-URL: Homepage, https://github.com/FAIRmat-NFDI/pynxtools-mpes
Project-URL: Bug Tracker, https://github.com/FAIRmat-NFDI/pynxtools-mpes/issues
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: pynxtools>=0.13.0
Provides-Extra: dev
Requires-Dist: mypy; extra == "dev"
Requires-Dist: ruff>=0.15.0; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pytest-timeout; extra == "dev"
Requires-Dist: types-pyyaml; extra == "dev"
Requires-Dist: types-pytz; extra == "dev"
Requires-Dist: types-requests; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: cruft; extra == "dev"
Provides-Extra: docs
Requires-Dist: mkdocs; extra == "docs"
Requires-Dist: mkdocs-material; extra == "docs"
Requires-Dist: mkdocs-material-extensions; extra == "docs"
Requires-Dist: mkdocs-macros-plugin; extra == "docs"
Requires-Dist: pymdown-extensions; extra == "docs"
Requires-Dist: mkdocs-click; extra == "docs"
Provides-Extra: nomad
Requires-Dist: nomad-lab[infrastructure]>=1.4.1; extra == "nomad"

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
![](https://github.com/FAIRmat-NFDI/pynxtools-mpes/actions/workflows/pytest.yml/badge.svg)
![](https://github.com/FAIRmat-NFDI/pynxtools-mpes/actions/workflows/pylint.yml/badge.svg)
![](https://github.com/FAIRmat-NFDI/pynxtools-mpes/actions/workflows/publish.yml/badge.svg)
![](https://img.shields.io/pypi/pyversions/pynxtools-mpes)
![](https://img.shields.io/pypi/l/pynxtools-mpes)
![](https://img.shields.io/pypi/v/pynxtools-mpes)
[![Coverage Status](https://coveralls.io/repos/github/FAIRmat-NFDI/mpes/badge.svg?branch=main&kill_cache=1)](https://coveralls.io/github/FAIRmat-NFDI/pynxtools-mpes?branch=main)
[![DOI](https://zenodo.org/badge/759916501.svg)](https://doi.org/10.5281/zenodo.16684290)

# `pynxtools-mpes`: A `pynxtools` reader for MPES data

`pynxtools-mpes`-mpes is a `pynxtools` reader plugin for multidimensional photoelectron spectroscopy (MPES) data.

This `pynxtools` plugin was generated with [`cookiecutter`](https://github.com/cookiecutter/cookiecutter) using the [`pynxtools-plugin-template`](https://github.com/FAIRmat-NFDI/pynxtools-plugin-template) template.

## Installation

It is recommended to use python 3.12 with a dedicated virtual environment for this package. Learn how to manage [python versions](https://github.com/pyenv/pyenv) and [virtual environments](https://realpython.com/python-virtual-environments-a-primer/).

This package is a reader plugin for [`pynxtools`](https://github.com/FAIRmat-NFDI/pynxtools) and should be installed together with `pynxtools`:

```shell
uv pip install pynxtools[mpes]
```

for the latest released version.

## Docs

More information about this pynxtools plugin is available in the [documentation](https://fairmat-nfdi.github.io/pynxtools-mpes/). You will find information about getting started, how-to guides, the supported file formats, how to get involved, and much more there.

## Contact person in FAIRmat for this reader

Lukas Pielsticker, Laurenz Rettig, [the FAIRmat team](https://www.fair-di.eu/fairmat/about-fairmat/team-fairmat)

## How to cite this work

Dobener, F., Rettig, L., Pielsticker, L., Pincelli, T., Abeer, A., Mozumder, R., & Brockhauser, S. (2025). pynxtools-mpes: A pynxtools reader plugin for multidimensional photoemission spectroscopy (MPES) data. Zenodo. https://doi.org/10.5281/zenodo.16684729
