Metadata-Version: 2.4
Name: pyebsdindex
Version: 0.3.9.2
Summary: Python based tool for Radon based EBSD indexing
Home-page: https://pyebsdindex.readthedocs.io
Download-URL: https://pypi.python.org/pypi/pyebsdindex
Author: ['Dave Rowenhorst', 'Håkon Wiik Ånes']
Maintainer: Dave Rowenhorst
Maintainer-email: 
License: Custom
Project-URL: Bug Tracker, https://github.com/USNavalResearchLaboratory/PyEBSDIndex/issues
Project-URL: Documentation, https://pyebsdindex.readthedocs.io
Project-URL: Source Code, https://github.com/USNavalResearchLaboratory/PyEBSDIndex
Keywords: EBSD,electron backscatter diffraction,HI,Radon indexing,NLPAR
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: Other/Proprietary License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: License
Requires-Dist: h5py
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: numba>=0.55.1
Requires-Dist: scipy
Requires-Dist: psutil
Provides-Extra: doc
Requires-Dist: nbsphinx>=0.7; extra == "doc"
Requires-Dist: numpydoc; extra == "doc"
Requires-Dist: pydata-sphinx-theme; extra == "doc"
Requires-Dist: sphinx>=3.0.2; extra == "doc"
Requires-Dist: sphinx-codeautolink[ipython]; extra == "doc"
Requires-Dist: sphinx-copybutton>=0.2.5; extra == "doc"
Requires-Dist: sphinx-design; extra == "doc"
Requires-Dist: sphinx-gallery; extra == "doc"
Provides-Extra: tests
Requires-Dist: coverage>=5.0; extra == "tests"
Requires-Dist: pytest>=5.4; extra == "tests"
Requires-Dist: pytest-cov>=2.8.1; extra == "tests"
Provides-Extra: gpu
Requires-Dist: pyopencl; extra == "gpu"
Provides-Extra: parallel
Requires-Dist: ray[default]<2.53; extra == "parallel"
Provides-Extra: dev
Requires-Dist: nbsphinx>=0.7; extra == "dev"
Requires-Dist: numpydoc; extra == "dev"
Requires-Dist: pydata-sphinx-theme; extra == "dev"
Requires-Dist: sphinx>=3.0.2; extra == "dev"
Requires-Dist: sphinx-codeautolink[ipython]; extra == "dev"
Requires-Dist: sphinx-copybutton>=0.2.5; extra == "dev"
Requires-Dist: sphinx-design; extra == "dev"
Requires-Dist: sphinx-gallery; extra == "dev"
Requires-Dist: coverage>=5.0; extra == "dev"
Requires-Dist: pytest>=5.4; extra == "dev"
Requires-Dist: pytest-cov>=2.8.1; extra == "dev"
Requires-Dist: pyopencl; extra == "dev"
Requires-Dist: ray[default]<2.53; extra == "dev"
Provides-Extra: all
Requires-Dist: pyopencl; extra == "all"
Requires-Dist: ray[default]<2.53; extra == "all"
Requires-Dist: nbsphinx>=0.7; extra == "all"
Requires-Dist: numpydoc; extra == "all"
Requires-Dist: pydata-sphinx-theme; extra == "all"
Requires-Dist: sphinx>=3.0.2; extra == "all"
Requires-Dist: sphinx-codeautolink[ipython]; extra == "all"
Requires-Dist: sphinx-copybutton>=0.2.5; extra == "all"
Requires-Dist: sphinx-design; extra == "all"
Requires-Dist: sphinx-gallery; extra == "all"
Requires-Dist: coverage>=5.0; extra == "all"
Requires-Dist: pytest>=5.4; extra == "all"
Requires-Dist: pytest-cov>=2.8.1; extra == "all"
Requires-Dist: pyopencl; extra == "all"
Requires-Dist: ray[default]<2.53; extra == "all"
Dynamic: author
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: download-url
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: maintainer
Dynamic: project-url
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# PyEBSDIndex

Python based tool for Radon based EBSD orientation indexing.

[![Tests status](https://github.com/USNavalResearchLaboratory/PyEBSDIndex/actions/workflows/tests.yml/badge.svg)](https://github.com/USNavalResearchLaboratory/PyEBSDIndex/actions/workflows/tests.yml)
[![Documentation status](https://readthedocs.org/projects/pyebsdindex/badge/?version=latest)](https://pyebsdindex.readthedocs.io/en/latest/)
[![PyPI version](https://img.shields.io/pypi/v/pyebsdindex.svg)](https://pypi.python.org/pypi/pyebsdindex)

The pattern processing is based on a GPU pipeline.  Details can be found
in D. J. Rowenhorst, P. G. Callahan, H. W. Ånes. Fast Radon transforms for
high-precision EBSD orientation determination using PyEBSDIndex. Journal of
Applied Crystallography, 57(1):3–19, 2024. and is based on the work of S. I.
Wright and B. L. Adams. Metallurgical Transactions A-Physical Metallurgy and
Materials Science, 23(3):759–767, 1992, and N. Krieger Lassen. Automated
Determination of Crystal Orientations from Electron Backscattering Patterns.
PhD thesis, The Technical University of Denmark, 1994. 

The band indexing is achieved through triplet voting using the methods outlined by A.
Morawiec. Acta Crystallographica Section A Foundations and Advances, 76(6):719–734,
2020.

Additionally NLPAR pattern processing is included (original distribution
[NLPAR](https://github.com/USNavalResearchLaboratory/NLPAR); P. T. Brewick, S. I.
Wright, and D. J. Rowenhorst. Ultramicroscopy, 200:50–61, May 2019.).

Documentation with installation instructions, a user guide, API reference, changelog,
and contributing guide is available at https://pyebsdindex.readthedocs.io.

## Installation

See [the documentation](https://pyebsdindex.readthedocs.io/en/stable/installation.html)
for installation instructions.
