Skip to content

pyxem/kikuchipy

Repository files navigation

logo

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!

About

Toolbox for analysis of electron backscatter diffraction (EBSD) patterns

Topics

Resources

License

GPL-3.0, BSD-3-Clause licenses found

Licenses found

GPL-3.0
LICENSE
BSD-3-Clause
LICENSE-BSD-3-Clause

Stars

113 stars

Watchers

5 watching

Forks

Contributors

Languages