kikuchipy 0.13.1 documentation#

kikuchipy is a library for processing, simulating and analyzing electron backscatter diffraction (EBSD) patterns in Python, built on the tools for multi-dimensional data analysis provided by the HyperSpy library.

See Licensing for details on licensing.

Installation#

kikuchipy can be installed with pip or conda:

pip install kikuchipy

conda install kikuchipy -c conda-forge

Further details are available in the installation guide.

Learning resources#

Tutorials

In-depth guides for using kikuchipy.

Tutorials

Examples

Short recipies to common tasks using kikuchipy.

Examples

API reference

Descriptions of all functions, modules, and objects in kikuchipy.

API reference

Contributing

kikuchipy is a community project maintained for and by its users. There are many ways you can help!

Contributing

Citing kikuchipy#

If you are using kikuchipy in your research, please help our scientific visibility by citing our work!

Paper:

@article{aanes2026kikuchipy,
  author  = {{\AA}nes, H{\aa}kon W and Crout, Phillip and Lervik, Lars Andreas and Natlandsmyr, Ole and Bergh, Tina and Hjelen, Jarle and van Helvoort, Antonius TJ and Marthinsen, Knut},
  title   = {{kikuchipy: an open-source toolbox for analysis of EBSD patterns}},
  doi     = {10.1093/mam/ozag097},
  pages   = {Accepted},
  journal = {Microscopy and Microanalysis},
  year    = {2026},
}

Pre-print:

@article{aanes2026kikuchipy_arxiv,
  author  = {{\AA}nes, H{\aa}kon W and Crout, Phillip and Lervik, Lars Andreas and Natlandsmyr, Ole and Bergh, Tina and Hjelen, Jarle and van Helvoort, Antonius TJ and Marthinsen, Knut},
  title   = {{kikuchipy: an open-source toolbox for analysis of EBSD patterns}},
  doi     = {10.48550/arXiv.2605.25722},
  journal = {arXiv preprint arXiv:2605.25722},
  year    = {2026},
}

Software DOI on Zenodo: https://doi.org/10.5281/zenodo.3597646.