The xcdskd project provides a collection of Jupyter notebooks which discuss and explain a number of data analysis approaches which are applicable in the context of Kikuchi Diffraction Methods, predominantly Electron Backscatter Diffraction (EBSD), Electron Channeling Patterns (ECP), and Electron Channeling Contrast Imaging (ECCI) in the scanning electron microscope (SEM).
The notebooks document the application of the aloe package, which bundles the central functionalities for Kikuchi pattern analysis. Because the notebooks contain working Python code, users can directly adapt them to their own needs and run the modified notebooks on the provided example data, as well as on their own data sets.
The focus of this project is more on the clear explanation of key concepts and work flows, and less on how to reach the ultimate optimization of numerical efficiency. The project also aims to provide open, documented reference algorithms and example data as a benchmark and basis for further developments.
If you use the Anaconda Python distribution:
Create a conda environment will all dependencies, named "xcdskd":
conda env create -f xcdskd_environment.yml
Activate the environment:
activate xcdskd
Install the aloe package in development mode (you can edit python modules in place):
python setup.py develop
Build the html documentation:
cd doc
rebuild_html.cmd