Skip to content

Latest commit

 

History

History
88 lines (59 loc) · 2.05 KB

index.rst

File metadata and controls

88 lines (59 loc) · 2.05 KB

kikuchipy 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.

user/index.rst reference/index.rst dev/index.rst changelog.rst

Installation

kikuchipy can be installed with pip or conda:

pip

pip install kikuchipy

conda

conda install kikuchipy -c conda-forge

Further details are available in the installation guide <user/installation>.

Learning resources

2

book;2em;sd-text-info Tutorials ^^^

In-depth guides for using kikuchipy.

zap;2em;sd-text-info Examples ^^^

Short recipies to common tasks using kikuchipy.

code;2em;sd-text-info API reference ^^^

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

people;2em;sd-text-info Contributing ^^^

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

Citing kikuchipy

If you are using kikuchipy in your scientific research, please help our scientific visibility by citing the Zenodo DOI: https://doi.org/10.5281/zenodo.3597646.