/kikuchipy

kikuchipy is an open-source Python library for processing and analysis of electron backscatter diffraction (EBSD) patterns.

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

kikuchipy [ki-ko-chi-pai] is a library for processing, simulating and indexing of electron backscatter diffraction (EBSD) patterns in Python, built on the tools for multi-dimensional data analysis provided by the HyperSpy library.

Deployment PyPI version Anaconda version
Build status Test status
Documentation Documentation status Launch binder
Metrics Coverage status
Activity PyPI downloads Anaconda downloads
Citation Zenodo DOI
Community Gitter chat GitHub discussion
License License

Documentation

Refer to the documentation for detailed installation instructions, a user guide, and the changelog.

Installation

kikuchipy can be installed with pip:

pip install kikuchipy

or conda:

conda install kikuchipy -c conda-forge

You can also visit PyPI, Anaconda, or GitHub to download the source.

Further details are available in the installation guide.

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.

Contributors ✨

Thanks go to these wonderful people (emoji key):

AndreasBugten
AndreasBugten
📖		 Carter Francis
Carter Francis
📖		 Eric Prestat
Eric Prestat
💻 🚧 🐛		 Håkon Wiik Ånes
Håkon Wiik Ånes
 Lars Lervik
Lars Lervik
🐛 💻 📖 💬 👀 ⚠️		 Magnus Nord
Magnus Nord
📖		 Ole Natlandsmyr
Ole Natlandsmyr
💻 📖 💬 👀 ⚠️
Tina Bergh
Tina Bergh
💻 👀		 Zhou Xu
Zhou Xu
🐛 💻 📖 ⚠️		 erlenmos
erlenmos
🐛

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