kikuchipy [ki-ko-chi-pai] 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.
- User guide and API reference: https://kikuchipy.org. The guide consists of Jupyter
Notebooks with many links to detailed explanations of the input parameters and output
of functions and class methods (the API reference). The notebooks can be inspected
statically on the web page or via
nbviewer,
downloaded and run locally, or run interactively in the browser by clicking the Binder
link above and navigating to the
doc/user_guidedirectory. We hope you find them useful! - License: kikuchipy is released under the GPLv3+ license.
- Cite: If you find this project useful, please cite the DOI above.
- Changelog: The library is in continuous development (alpha stage), so expect some breaking changes with each release. Please see the changelog for all developments.
Thanks goes to these wonderful people (emoji key):
 Eric Prestat 💻 🚧 |
 Håkon Wiik Ånes |
 Lars Lervik 🐛 💻 📖 💬 👀 |
 Ole Natlandsmyr 💻 📖 💬 👀 |
 Tina Bergh 💻 👀 |
 Zhou Xu 🐛 💻 📖 |
This project follows the all-contributors specification. Contributions of any kind welcome! Please see our contributing guide for information on how best to contribute (or just explain what you want to do in an issue).