Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pyxem/kikuchipy

Toolbox for analysis of electron backscatter diffraction (EBSD) patterns
https://github.com/pyxem/kikuchipy

ebsd electron-backscatter-diffraction hyperspy hyperspy-extension pattern-matching python

Last synced: 5 days ago
JSON representation

Toolbox for analysis of electron backscatter diffraction (EBSD) patterns

Host: GitHub
URL: https://github.com/pyxem/kikuchipy
Owner: pyxem
License: gpl-3.0
Created: 2018-12-03T09:54:22.000Z (almost 6 years ago)
Default Branch: develop
Last Pushed: 2024-11-07T20:48:59.000Z (13 days ago)
Last Synced: 2024-11-07T21:18:28.486Z (13 days ago)
Topics: ebsd, electron-backscatter-diffraction, hyperspy, hyperspy-extension, pattern-matching, python
Language: Python
Homepage: https://kikuchipy.org
Size: 183 MB
Stars: 81
Watchers: 6
Forks: 30
Open Issues: 30
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.rst

Awesome Lists containing this project

README

|logo|
======

.. |logo| image:: https://raw.githubusercontent.com/pyxem/kikuchipy/develop/doc/_static/logo/plasma_banner.png
:width: 50%
:target: https://kikuchipy.org

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.

.. |pypi_version| image:: https://img.shields.io/pypi/v/kikuchipy.svg?logo=python&logoColor=white
:target: https://pypi.python.org/pypi/kikuchipy

.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/kikuchipy.svg?logo=conda-forge&logoColor=white
:target: https://anaconda.org/conda-forge/kikuchipy

.. |tests_status| image:: https://github.com/pyxem/kikuchipy/actions/workflows/tests.yml/badge.svg
:target: https://github.com/pyxem/kikuchipy/actions/workflows/tests.yml

.. |python| image:: https://img.shields.io/badge/python-3.10+-blue.svg
:target: https://www.python.org/downloads/

.. |Coveralls| image:: https://coveralls.io/repos/github/pyxem/kikuchipy/badge.svg?branch=develop
:target: https://coveralls.io/github/pyxem/kikuchipy?branch=develop

.. |pypi_downloads| image:: https://img.shields.io/pypi/dm/kikuchipy.svg?label=pypi%20downloads
:target: https://pypi.org/project/kikuchipy

.. |conda_downloads| image:: https://img.shields.io/conda/dn/conda-forge/kikuchipy.svg?label=conda%20downloads
:target: https://anaconda.org/conda-forge/kikuchipy

.. |doi| image:: https://zenodo.org/badge/doi/10.5281/zenodo.3597646.svg
:target: https://doi.org/10.5281/zenodo.3597646

.. |GPLv3| image:: https://img.shields.io/github/license/pyxem/kikuchipy
:target: https://opensource.org/license/GPL-3.0

.. |GH-discuss| image:: https://img.shields.io/badge/GitHub-Discussions-green?logo=github
:target: https://github.com/pyxem/kikuchipy/discussions

.. |binder| image:: https://mybinder.org/badge_logo.svg
:target: https://mybinder.org/v2/gh/pyxem/kikuchipy/HEAD

.. |docs| image:: https://readthedocs.org/projects/kikuchipy/badge/?version=latest
:target: https://kikuchipy.org/en/latest

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black

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 `__.