kikuchipy is an open-source Python library for processing and analysis of electron backscatter diffraction (EBSD) patterns.
The Jupyter Notebooks in this repository demonstrate core functionality of the kikuchipy package. For learning purposes, we recommend to use them alongside our user guide.
If you are using the demos with a release version of kikuchipy that you installed from PyPI or Anaconda, then you should use the corresponding release version of the demos. See either the "releases" tab above or the Zenodo DOI (coming soon).
If you have any problems using any of the notebooks, please raise an issue in our issue tracker so that we can help!
Data used in all demos is available Zenodo.
- Visualize the demos online via nbviewer.
- Interactively online: We plan to make interactive notebooks available via mybinder shortly.
- Locally: To run the notebooks locally, clone or download this demos repository to your machine, install kikuchipy and Jupyter Lab (or Jupyter Notebook) and use Jupyter to run the notebooks.
Everyone is welcome to contribute. To contribute new demos or improvements to current demos, fork this demos repository and send a pull request. See the contribution guide for more details on how to contribute to kikuchipy.
If you find kikuchipy useful, please cite the package as explained here. If you find these example notebooks helpful, please cite the DOI above (coming soon).