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

Deployment

pypi_version conda

Build status

tests_status docs python

Metrics

coverage

Activity

pypi_downloads conda_downloads

Citation

arxiv_doi zenodo_doi

License

GPLv3 BSD3

Community

GH-discuss

Formatter

black

kikuchipy is licensed under the GNU General Public License v3+. Select components are individually licensed under the BSD 3-Clause License, allowing reuse of those components only in both GPL and non-GPL projects.

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 research, please help our scientific visibility by citing our work!

Paper:

@article{aanes2026kikuchipy,
  author  = {{\AA}nes, H{\aa}kon W and Crout, Phillip and Lervik, Lars Andreas and Natlandsmyr, Ole and Bergh, Tina and Hjelen, Jarle and van Helvoort, Antonius TJ and Marthinsen, Knut},
  title   = {{kikuchipy: an open-source toolbox for analysis of EBSD patterns}},
  doi     = {10.1093/mam/ozag097},
  pages   = {Accepted},
  journal = {Microscopy and Microanalysis},
  year    = {2026},
}

Pre-print:

@article{aanes2026kikuchipy_arxiv,
  author  = {{\AA}nes, H{\aa}kon W and Crout, Phillip and Lervik, Lars Andreas and Natlandsmyr, Ole and Bergh, Tina and Hjelen, Jarle and van Helvoort, Antonius TJ and Marthinsen, Knut},
  title   = {{kikuchipy: an open-source toolbox for analysis of EBSD patterns}},
  doi     = {10.48550/arXiv.2605.25722},
  journal = {arXiv preprint arXiv:2605.25722},
  year    = {2026},
}

Software DOI on Zenodo: https://doi.org/10.5281/zenodo.3597646.

Project links

Data verified by PyPI on Sep 4, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for hakonanes from gravatar.com hakonanes

Credits

Author: kikuchipy developers

Maintainer: Håkon Wiik Ånes

GitHub Statistics

Data verified by PyPI on Sep 4, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

BSD License, GNU General Public License v3 or later (GPLv3+) (GNU GENERAL PUBLIC LICENSE)

Requires

Python >=3.10

Provides Extra

all coverage dev doc tests

Tags

BKD EBSD EBSP SEM backscatter kikuchi diffraction dictionary indexing electron backscatter diffraction electron backscatter pattern kikuchi pattern scanning electron microscopy

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kikuchipy-0.13.1.tar.gz (21.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kikuchipy-0.13.1-py3-none-any.whl (1.8 MB view details)

Uploaded Python 3

File details

Details for the file kikuchipy-0.13.1.tar.gz.

File metadata

  • Download URL: kikuchipy-0.13.1.tar.gz
  • Upload date:
  • Size: 21.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for kikuchipy-0.13.1.tar.gz
Algorithm Hash digest
SHA256 e5dc1e1ae15b4619110bee4a3ccc74c0a1da825015eb33bef73dcea6bad95ea4
MD5 1e7ce36e1744254ee4f265c3fd265be7
BLAKE2b-256 116d8b4976458f5a94b4cd44fac1da3db51ec543aaa0dde8ec77001dfa95653c

See more details on using hashes here.

File details

Details for the file kikuchipy-0.13.1-py3-none-any.whl.

File metadata

  • Download URL: kikuchipy-0.13.1-py3-none-any.whl
  • Upload date:
  • Size: 1.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for kikuchipy-0.13.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f389042a3d798d376c29a0eac0a6262cea4f9f0712ab2abb586086f8d15d762c
MD5 f89efb8cad68d84d5c1cbbdec225c0a3
BLAKE2b-256 88f4d6c4e92bcf7da80a6b591cc54419b1e20aeea76bd3430855154eb0a69682

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.13.1 This release

2 files

0.13.0

2 files

0.12.2

2 files

0.12.1

2 files

0.12.0

2 files

Yanked

0.12.dev4

2 files

Yanked reason: Package built from wrong branch

0.11.5

2 files

0.11.4

2 files

0.11.3

2 files

0.11.2

2 files

0.11.1.post0

2 files

0.11.1

2 files

0.11.0

2 files

0.10.0

2 files

0.9.0

2 files

0.8.7

2 files

0.8.6

2 files

0.8.5

2 files

0.8.4

2 files

0.8.3

2 files

0.8.2

2 files

0.8.1

2 files

0.8.0

2 files

0.7.0

2 files

0.6.1

2 files

0.6.0

2 files

0.5.8

2 files

0.5.7

2 files

0.5.6

2 files

0.5.5

2 files

0.5.4

2 files

0.5.3

2 files

0.5.2

2 files

0.5.1

2 files

Pre-release

0.5.1rc1

2 files

0.5.0

2 files

0.4.0

2 files

0.3.4

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

Pre-release

0.3.0rc1

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page