Metadata-Version: 2.4
Name: pynxtools-microstructure
Version: 0.1.0
Author-email: The NOMAD Authors <fairmat@physik.hu-berlin.de>
Project-URL: Homepage, https://github.com/FAIRmat-NFDI/pynxtools-microstructure
Project-URL: Bug Tracker, https://github.com/FAIRmat-NFDI/pynxtools-microstructure/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: Programming Language :: Python :: 3.14
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pynxtools>=0.14
Requires-Dist: pynxtools-em>=0.4.4
Provides-Extra: dev
Requires-Dist: mypy; extra == "dev"
Requires-Dist: ruff>=0.15; 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.2; extra == "nomad"
Provides-Extra: north
Requires-Dist: jupyterlab-h5web; extra == "north"
Requires-Dist: jupyterlab; extra == "north"
Requires-Dist: ipywidgets; extra == "north"
Dynamic: license-file

<!-- [![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-microstructure/actions/workflows/pytest.yml/badge.svg)
![](https://github.com/FAIRmat-NFDI/pynxtools-microstructure/actions/workflows/pylint.yml/badge.svg)
![](https://github.com/FAIRmat-NFDI/pynxtools-microstructure/actions/workflows/publish.yml/badge.svg)
![](https://img.shields.io/pypi/pyversions/pynxtools-microstructure)
![](https://img.shields.io/pypi/l/pynxtools-microstructure)
![](https://img.shields.io/pypi/v/pynxtools-microstructure)
![Coverage Status](https://coveralls.io/repos/github/FAIRmat-NFDI/pynxtools-microstructure/badge.svg?branch=main)-->

# `pynxtools-microstructure`: A `pynxtools` reader for MICROSTRUCTURE 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[microstructure]
```

for the latest released version.

## Docs

More information about this pynxtools plugin is available in the [documentation](https://fairmat-nfdi.github.io/pynxtools-microstructure/). 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

Markus Kühbach

<!-- ## How to cite this work -->
