kikuchipy

Build status Coveralls status Documentation status PyPI version conda-forge version DOI

kikuchipy is an open-source Python library for processing and analysis of electron backscatter diffraction (EBSD) patterns.

The library builds on the tools for multi-dimensional data analysis provided by the HyperSpy library. An effort is made to keep memory usage in check and enable scalability by using the Dask library for pattern processing.

The project is in an alpha stage, and there will likely be breaking changes with each release.

kikuchipy is released under the GPLv3+ license.

User guide

Installation instructions, a user guide and the full API reference are available from our webpage.

Tutorials and example workflows

Jupyter Notebooks that you can work through and modify to perform processing and analyses of EBSD patterns are available here. For learning purposes, we recommend to use them alongside our user guide.

Contributing

Everyone is welcome to contribute. Please read our contributor guide to get started!

Code of Conduct

kikuchipy has a Code of Conduct that should be honoured by everyone who participates in the kikuchipy community.

Cite

If you find this project useful, please cite the DOI above.