Metadata-Version: 2.4
Name: pyebsdindex
Version: 0.3.10
Summary: Python based tool for Radon based EBSD indexing
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
Project-URL: Homepage, https://pyebsdindex.readthedocs.io
Author: Dave Rowenhorst
Maintainer: Dave Rowenhorst
License: This software, PyEBSDIndex, was developed by employees of the US Naval Research Laboratory (NRL), an
        agency of the Federal Government. Pursuant to title 17 section 105 of the United States
        Code, works of NRL employees are not subject to copyright protection, and this software
        is in the public domain. PyEBSDIndex is an experimental system. NRL assumes no
        responsibility whatsoever for its use by other parties, and makes no guarantees,
        expressed or implied, about its quality, reliability, or any other characteristic. We
        would appreciate acknowledgment if the software is used. To the extent that NRL may hold
        copyright in countries other than the United States, you are hereby granted the
        non-exclusive irrevocable and unconditional right to print, publish, prepare derivative
        works and distribute this software, in any medium, or authorize others to do so on your
        behalf, on a royalty-free basis throughout the world. You may improve, modify, and
        create derivative works of the software or any portion of the software, and you may copy
        and distribute such modifications or works. Modified works should carry a notice stating
        that you changed the software and should note the date and nature of any such change.
        Please explicitly acknowledge the US Naval Research Laboratory as the original source.
        This software can be redistributed and/or modified freely provided that any derivative
        works bear some notice that they are derived from it, and any modified versions bear
        some notice that they have been modified.
        
        Author: David Rowenhorst; 
        The US Naval Research Laboratory Date: 22 May 2024
        
Keywords: EBSD,HI,NLPAR,Radon indexing,electron backscatter diffraction
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: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.10
Requires-Dist: h5py
Requires-Dist: matplotlib
Requires-Dist: numba>=0.55.1
Requires-Dist: numpy
Requires-Dist: psutil
Requires-Dist: scipy
Provides-Extra: all
Requires-Dist: pyopencl; extra == 'all'
Requires-Dist: ray[default]; extra == 'all'
Provides-Extra: dev
Requires-Dist: coverage>=5.0; extra == 'dev'
Requires-Dist: nbsphinx>=0.7; extra == 'dev'
Requires-Dist: numpydoc; extra == 'dev'
Requires-Dist: pydata-sphinx-theme; extra == 'dev'
Requires-Dist: pyopencl; extra == 'dev'
Requires-Dist: pytest-cov>=2.8.1; extra == 'dev'
Requires-Dist: pytest>=5.4; extra == 'dev'
Requires-Dist: ray[default]; 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: sphinx>=3.0.2; extra == 'dev'
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-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'
Requires-Dist: sphinx>=3.0.2; extra == 'doc'
Provides-Extra: gpu
Requires-Dist: pyopencl; extra == 'gpu'
Provides-Extra: parallel
Requires-Dist: ray[default]; extra == 'parallel'
Provides-Extra: tests
Requires-Dist: coverage>=5.0; extra == 'tests'
Requires-Dist: pytest-cov>=2.8.1; extra == 'tests'
Requires-Dist: pytest>=5.4; extra == 'tests'
Description-Content-Type: text/markdown

# 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/index.html)
for installation instructions.
