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 |
|
Build status |
|
Metrics |
|
Activity |
|
Citation |
|
License |
|
Community |
|
Formatter |
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.
1 maintainer
Metadata
1 maintainer
Release files for kikuchipy 0.14.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| kikuchipy-0.14.0.tar.gz | 23.1 MB | With provenance | Details for kikuchipy-0.14.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| kikuchipy-0.14.0-py3-none-any.whl | Python 3 | none | any | Details for kikuchipy-0.14.0-py3-none-any.whl |
Total release size: 24.9 MB
Release files / kikuchipy-0.14.0.tar.gz
| Download URL | kikuchipy-0.14.0.tar.gz |
|---|---|
| Size | 23.1 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
759c2a2f1f1aa1cc899996d8df45d7f2f37e78b0c544d2b4352440d5695c25a4
|
|
BLAKE2b-256 checksum How to use checksums |
bc44a70069e3706744092ab29ac1ef3817bdb9c56f0194711ea2bc50767cfdef
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 8, 2026.
Transparency logRelease files / kikuchipy-0.14.0-py3-none-any.whl
| Download URL | kikuchipy-0.14.0-py3-none-any.whl |
|---|---|
| Size | 1.8 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
238312f77eab1e572cdeb2b51a484cb8e88c77470cd51ae88984e552e3062745
|
|
BLAKE2b-256 checksum How to use checksums |
5989fa37c8c3d9adb4a065ed541bc3ebfafc530a59747422a7996a82e5e38261
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 8, 2026.
Transparency logSecurity for kikuchipy 0.14.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for kikuchipy-0.14.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 8, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
