<div align="center">
<a href="https://kikuchipy.org">
<img width="60%" src="https://raw.githubusercontent.com/pyxem/kikuchipy/develop/doc/_static/logo/plasma_banner.png">
</a>
</div>
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 | [](https://pypi.org/project/kikuchipy/) | [](https://anaconda.org/conda-forge/kikuchipy)|
| :- | :- | :- |
| **Build status** | [](https://github.com/pyxem/kikuchipy/actions/workflows/tests.yml) |
| **Documentation** | [](https://kikuchipy.org/en/latest/) | [](https://mybinder.org/v2/gh/pyxem/kikuchipy/HEAD) |
| **Metrics** | [](https://coveralls.io/github/pyxem/kikuchipy?branch=develop) |
| **Activity** | [](https://pypi.org/project/kikuchipy/) | [](ttps://anaconda.org/conda-forge/kikuchipy) |
| **Citation** | [](https://doi.org/10.5281/zenodo.3597646) |
| **Community** | [](https://gitter.im/pyxem/kikuchipy) | [](https://github.com/pyxem/kikuchipy/discussions) |
| **License** | [](https://opensource.org/licenses/GPL-3.0) |
## Documentation
Refer to the [documentation](https://kikuchipy.org) for detailed installation
instructions, a user guide, and the
[changelog](https://kikuchipy.org/en/latest/changelog.html).
## Installation
kikuchipy can be installed with `pip`:
```bash
pip install kikuchipy
```
or `conda`:
```bash
conda install kikuchipy -c conda-forge
```
You can also visit [PyPI](https://pypi.org/project/kikuchipy),
[Anaconda](https://anaconda.org/conda-forge/kikuchipy), or
[GitHub](https://github.com/pyxem/kikuchipy) to download the source.
Further details are available in the
[installation guide](https://kikuchipy.org/en/latest/user/installation.html).
## 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](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tbody>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/AndreasBugten"><img src="https://avatars.githubusercontent.com/u/106192446?v=4?s=100" width="100px;" alt="AndreasBugten"/><br /><sub><b>AndreasBugten</b></sub></a><br /><a href="https://github.com/pyxem/kikuchipy/commits?author=AndreasBugten" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/CSSFrancis"><img src="https://avatars.githubusercontent.com/u/41125831?v=4?s=100" width="100px;" alt="Carter Francis"/><br /><sub><b>Carter Francis</b></sub></a><br /><a href="https://github.com/pyxem/kikuchipy/commits?author=CSSFrancis" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/ericpre"><img src="https://avatars.githubusercontent.com/u/11851990?v=4?s=100" width="100px;" alt="Eric Prestat"/><br /><sub><b>Eric Prestat</b></sub></a><br /><a href="https://github.com/pyxem/kikuchipy/commits?author=ericpre" title="Code">💻</a> <a href="#maintenance-ericpre" title="Maintenance">🚧</a> <a href="https://github.com/pyxem/kikuchipy/issues?q=author%3Aericpre" title="Bug reports">🐛</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://www.ntnu.edu/employees/hakon.w.anes"><img src="https://avatars.githubusercontent.com/u/12139781?v=4?s=100" width="100px;" alt="Håkon Wiik Ånes"/><br /><sub><b>Håkon Wiik Ånes</b></sub></a><br /></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/friedkitteh"><img src="https://avatars.githubusercontent.com/u/11888052?v=4?s=100" width="100px;" alt="Lars Lervik"/><br /><sub><b>Lars Lervik</b></sub></a><br /><a href="https://github.com/pyxem/kikuchipy/issues?q=author%3Afriedkitteh" title="Bug reports">🐛</a> <a href="https://github.com/pyxem/kikuchipy/commits?author=friedkitteh" title="Code">💻</a> <a href="https://github.com/pyxem/kikuchipy/commits?author=friedkitteh" title="Documentation">📖</a> <a href="#question-friedkitteh" title="Answering Questions">💬</a> <a href="https://github.com/pyxem/kikuchipy/pulls?q=is%3Apr+reviewed-by%3Afriedkitteh" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/pyxem/kikuchipy/commits?author=friedkitteh" title="Tests">⚠️</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://www.ntnu.edu/employees/magnus.nord"><img src="https://avatars.githubusercontent.com/u/1690979?v=4?s=100" width="100px;" alt="Magnus Nord"/><br /><sub><b>Magnus Nord</b></sub></a><br /><a href="https://github.com/pyxem/kikuchipy/commits?author=magnunor" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/onatlandsmyr"><img src="https://avatars.githubusercontent.com/u/34620114?v=4?s=100" width="100px;" alt="Ole Natlandsmyr"/><br /><sub><b>Ole Natlandsmyr</b></sub></a><br /><a href="https://github.com/pyxem/kikuchipy/commits?author=onatlandsmyr" title="Code">💻</a> <a href="https://github.com/pyxem/kikuchipy/commits?author=onatlandsmyr" title="Documentation">📖</a> <a href="#question-onatlandsmyr" title="Answering Questions">💬</a> <a href="https://github.com/pyxem/kikuchipy/pulls?q=is%3Apr+reviewed-by%3Aonatlandsmyr" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/pyxem/kikuchipy/commits?author=onatlandsmyr" title="Tests">⚠️</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/tinabe"><img src="https://avatars.githubusercontent.com/u/22915119?v=4?s=100" width="100px;" alt="Tina Bergh"/><br /><sub><b>Tina Bergh</b></sub></a><br /><a href="https://github.com/pyxem/kikuchipy/commits?author=tinabe" title="Code">💻</a> <a href="https://github.com/pyxem/kikuchipy/pulls?q=is%3Apr+reviewed-by%3Atinabe" title="Reviewed Pull Requests">👀</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/IMBalENce"><img src="https://avatars.githubusercontent.com/u/2986794?v=4?s=100" width="100px;" alt="Zhou Xu"/><br /><sub><b>Zhou Xu</b></sub></a><br /><a href="https://github.com/pyxem/kikuchipy/issues?q=author%3AIMBalENce" title="Bug reports">🐛</a> <a href="https://github.com/pyxem/kikuchipy/commits?author=IMBalENce" title="Code">💻</a> <a href="https://github.com/pyxem/kikuchipy/commits?author=IMBalENce" title="Documentation">📖</a> <a href="https://github.com/pyxem/kikuchipy/commits?author=IMBalENce" title="Tests">⚠️</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Erlendos12"><img src="https://avatars.githubusercontent.com/u/99336047?v=4?s=100" width="100px;" alt="erlenmos"/><br /><sub><b>erlenmos</b></sub></a><br /><a href="https://github.com/pyxem/kikuchipy/issues?q=author%3AErlendos12" title="Bug reports">🐛</a></td>
</tr>
</tbody>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification.
Contributions of any kind welcome! Please see our
[contributing guide](https://kikuchipy.org/en/latest/dev/index.html) for information
on how best to contribute (or just explain what you want to do
[in an issue](https://github.com/pyxem/kikuchipy/issues/new)).
Raw data
{
"_id": null,
"home_page": "https://kikuchipy.org",
"name": "kikuchipy",
"maintainer": "H\u00e5kon Wiik \u00c5nes",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "hakon.w.anes@ntnu.no",
"keywords": "EBSD,electron backscatter diffraction,EBSP,electron backscatter pattern,BKD,backscatter kikuchi diffraction,SEM,scanning electron microscopy,kikuchi pattern,dictionary indexing",
"author": "kikuchipy developers",
"author_email": "hakon.w.anes@ntnu.no",
"download_url": "https://files.pythonhosted.org/packages/d8/d4/2c724d61acffdefdbc0ff5c69176b32870e6672c96892b56e4f748702c24/kikuchipy-0.9.0.tar.gz",
"platform": "\"Linux\"",
"description": "<div align=\"center\">\n <a href=\"https://kikuchipy.org\">\n <img width=\"60%\" src=\"https://raw.githubusercontent.com/pyxem/kikuchipy/develop/doc/_static/logo/plasma_banner.png\">\n </a>\n</div>\n\nkikuchipy [ki-ko-chi-pai] is a library for processing, simulating and indexing of\nelectron backscatter diffraction (EBSD) patterns in Python, built on the tools for\nmulti-dimensional data analysis provided by the HyperSpy library.\n\n| Deployment | [](https://pypi.org/project/kikuchipy/) | [](https://anaconda.org/conda-forge/kikuchipy)|\n| :- | :- | :- |\n| **Build status** | [](https://github.com/pyxem/kikuchipy/actions/workflows/tests.yml) |\n| **Documentation** | [](https://kikuchipy.org/en/latest/) | [](https://mybinder.org/v2/gh/pyxem/kikuchipy/HEAD) |\n| **Metrics** | [](https://coveralls.io/github/pyxem/kikuchipy?branch=develop) |\n| **Activity** | [](https://pypi.org/project/kikuchipy/) | [](ttps://anaconda.org/conda-forge/kikuchipy) |\n| **Citation** | [](https://doi.org/10.5281/zenodo.3597646) |\n| **Community** | [](https://gitter.im/pyxem/kikuchipy) | [](https://github.com/pyxem/kikuchipy/discussions) |\n| **License** | [](https://opensource.org/licenses/GPL-3.0) |\n\n## Documentation\n\nRefer to the [documentation](https://kikuchipy.org) for detailed installation\ninstructions, a user guide, and the\n[changelog](https://kikuchipy.org/en/latest/changelog.html).\n\n## Installation\n\nkikuchipy can be installed with `pip`:\n\n```bash\npip install kikuchipy\n```\n\nor `conda`:\n\n```bash\nconda install kikuchipy -c conda-forge\n```\n\nYou can also visit [PyPI](https://pypi.org/project/kikuchipy),\n[Anaconda](https://anaconda.org/conda-forge/kikuchipy), or\n[GitHub](https://github.com/pyxem/kikuchipy) to download the source.\n\nFurther details are available in the\n[installation guide](https://kikuchipy.org/en/latest/user/installation.html).\n\n## Citing kikuchipy\n\nIf you are using kikuchipy in your scientific research, please help our scientific\nvisibility by citing the Zenodo DOI: https://doi.org/10.5281/zenodo.3597646.\n\n## Contributors \u2728\n\nThanks go to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->\n<!-- prettier-ignore-start -->\n<!-- markdownlint-disable -->\n<table>\n <tbody>\n <tr>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/AndreasBugten\"><img src=\"https://avatars.githubusercontent.com/u/106192446?v=4?s=100\" width=\"100px;\" alt=\"AndreasBugten\"/><br /><sub><b>AndreasBugten</b></sub></a><br /><a href=\"https://github.com/pyxem/kikuchipy/commits?author=AndreasBugten\" title=\"Documentation\">\ud83d\udcd6</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/CSSFrancis\"><img src=\"https://avatars.githubusercontent.com/u/41125831?v=4?s=100\" width=\"100px;\" alt=\"Carter Francis\"/><br /><sub><b>Carter Francis</b></sub></a><br /><a href=\"https://github.com/pyxem/kikuchipy/commits?author=CSSFrancis\" title=\"Documentation\">\ud83d\udcd6</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/ericpre\"><img src=\"https://avatars.githubusercontent.com/u/11851990?v=4?s=100\" width=\"100px;\" alt=\"Eric Prestat\"/><br /><sub><b>Eric Prestat</b></sub></a><br /><a href=\"https://github.com/pyxem/kikuchipy/commits?author=ericpre\" title=\"Code\">\ud83d\udcbb</a> <a href=\"#maintenance-ericpre\" title=\"Maintenance\">\ud83d\udea7</a> <a href=\"https://github.com/pyxem/kikuchipy/issues?q=author%3Aericpre\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://www.ntnu.edu/employees/hakon.w.anes\"><img src=\"https://avatars.githubusercontent.com/u/12139781?v=4?s=100\" width=\"100px;\" alt=\"H\u00e5kon Wiik \u00c5nes\"/><br /><sub><b>H\u00e5kon Wiik \u00c5nes</b></sub></a><br /></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/friedkitteh\"><img src=\"https://avatars.githubusercontent.com/u/11888052?v=4?s=100\" width=\"100px;\" alt=\"Lars Lervik\"/><br /><sub><b>Lars Lervik</b></sub></a><br /><a href=\"https://github.com/pyxem/kikuchipy/issues?q=author%3Afriedkitteh\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"https://github.com/pyxem/kikuchipy/commits?author=friedkitteh\" title=\"Code\">\ud83d\udcbb</a> <a href=\"https://github.com/pyxem/kikuchipy/commits?author=friedkitteh\" title=\"Documentation\">\ud83d\udcd6</a> <a href=\"#question-friedkitteh\" title=\"Answering Questions\">\ud83d\udcac</a> <a href=\"https://github.com/pyxem/kikuchipy/pulls?q=is%3Apr+reviewed-by%3Afriedkitteh\" title=\"Reviewed Pull Requests\">\ud83d\udc40</a> <a href=\"https://github.com/pyxem/kikuchipy/commits?author=friedkitteh\" title=\"Tests\">\u26a0\ufe0f</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://www.ntnu.edu/employees/magnus.nord\"><img src=\"https://avatars.githubusercontent.com/u/1690979?v=4?s=100\" width=\"100px;\" alt=\"Magnus Nord\"/><br /><sub><b>Magnus Nord</b></sub></a><br /><a href=\"https://github.com/pyxem/kikuchipy/commits?author=magnunor\" title=\"Documentation\">\ud83d\udcd6</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/onatlandsmyr\"><img src=\"https://avatars.githubusercontent.com/u/34620114?v=4?s=100\" width=\"100px;\" alt=\"Ole Natlandsmyr\"/><br /><sub><b>Ole Natlandsmyr</b></sub></a><br /><a href=\"https://github.com/pyxem/kikuchipy/commits?author=onatlandsmyr\" title=\"Code\">\ud83d\udcbb</a> <a href=\"https://github.com/pyxem/kikuchipy/commits?author=onatlandsmyr\" title=\"Documentation\">\ud83d\udcd6</a> <a href=\"#question-onatlandsmyr\" title=\"Answering Questions\">\ud83d\udcac</a> <a href=\"https://github.com/pyxem/kikuchipy/pulls?q=is%3Apr+reviewed-by%3Aonatlandsmyr\" title=\"Reviewed Pull Requests\">\ud83d\udc40</a> <a href=\"https://github.com/pyxem/kikuchipy/commits?author=onatlandsmyr\" title=\"Tests\">\u26a0\ufe0f</a></td>\n </tr>\n <tr>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/tinabe\"><img src=\"https://avatars.githubusercontent.com/u/22915119?v=4?s=100\" width=\"100px;\" alt=\"Tina Bergh\"/><br /><sub><b>Tina Bergh</b></sub></a><br /><a href=\"https://github.com/pyxem/kikuchipy/commits?author=tinabe\" title=\"Code\">\ud83d\udcbb</a> <a href=\"https://github.com/pyxem/kikuchipy/pulls?q=is%3Apr+reviewed-by%3Atinabe\" title=\"Reviewed Pull Requests\">\ud83d\udc40</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/IMBalENce\"><img src=\"https://avatars.githubusercontent.com/u/2986794?v=4?s=100\" width=\"100px;\" alt=\"Zhou Xu\"/><br /><sub><b>Zhou Xu</b></sub></a><br /><a href=\"https://github.com/pyxem/kikuchipy/issues?q=author%3AIMBalENce\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"https://github.com/pyxem/kikuchipy/commits?author=IMBalENce\" title=\"Code\">\ud83d\udcbb</a> <a href=\"https://github.com/pyxem/kikuchipy/commits?author=IMBalENce\" title=\"Documentation\">\ud83d\udcd6</a> <a href=\"https://github.com/pyxem/kikuchipy/commits?author=IMBalENce\" title=\"Tests\">\u26a0\ufe0f</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/Erlendos12\"><img src=\"https://avatars.githubusercontent.com/u/99336047?v=4?s=100\" width=\"100px;\" alt=\"erlenmos\"/><br /><sub><b>erlenmos</b></sub></a><br /><a href=\"https://github.com/pyxem/kikuchipy/issues?q=author%3AErlendos12\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n </tr>\n </tbody>\n</table>\n\n<!-- markdownlint-restore -->\n<!-- prettier-ignore-end -->\n\n<!-- ALL-CONTRIBUTORS-LIST:END -->\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification.\nContributions of any kind welcome! Please see our\n[contributing guide](https://kikuchipy.org/en/latest/dev/index.html) for information\non how best to contribute (or just explain what you want to do\n[in an issue](https://github.com/pyxem/kikuchipy/issues/new)).\n",
"bugtrack_url": null,
"license": "GPLv3+",
"summary": "Processing, simulating and indexing of electron backscatter diffraction (EBSD) patterns.",
"version": "0.9.0",
"project_urls": {
"Bug Tracker": "https://github.com/pyxem/kikuchipy/issues",
"Documentation": "https://kikuchipy.org",
"Download": "https://pypi.python.org/pypi/kikuchipy",
"Homepage": "https://kikuchipy.org",
"Source Code": "https://github.com/pyxem/kikuchipy"
},
"split_keywords": [
"ebsd",
"electron backscatter diffraction",
"ebsp",
"electron backscatter pattern",
"bkd",
"backscatter kikuchi diffraction",
"sem",
"scanning electron microscopy",
"kikuchi pattern",
"dictionary indexing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4e51e9a80f4eae24f6ad89fef77958861eb133c248796b7d8542228430824f3a",
"md5": "70e09d53690a0d47930d3b9ae6d1a6ad",
"sha256": "7f9e2c8c6d71f8382a3724d14ec2a5dd41a47a1f3e6aeee532498bf98c915a87"
},
"downloads": -1,
"filename": "kikuchipy-0.9.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "70e09d53690a0d47930d3b9ae6d1a6ad",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 1831891,
"upload_time": "2023-11-03T12:14:02",
"upload_time_iso_8601": "2023-11-03T12:14:02.384056Z",
"url": "https://files.pythonhosted.org/packages/4e/51/e9a80f4eae24f6ad89fef77958861eb133c248796b7d8542228430824f3a/kikuchipy-0.9.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d8d42c724d61acffdefdbc0ff5c69176b32870e6672c96892b56e4f748702c24",
"md5": "ec13471e68290d5027af30e66a202a67",
"sha256": "f0523ac0245d59c598fbaa0c62da46e5b08de306a62a7a99d4c140cc422772be"
},
"downloads": -1,
"filename": "kikuchipy-0.9.0.tar.gz",
"has_sig": false,
"md5_digest": "ec13471e68290d5027af30e66a202a67",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 1722592,
"upload_time": "2023-11-03T12:14:04",
"upload_time_iso_8601": "2023-11-03T12:14:04.478714Z",
"url": "https://files.pythonhosted.org/packages/d8/d4/2c724d61acffdefdbc0ff5c69176b32870e6672c96892b56e4f748702c24/kikuchipy-0.9.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-03 12:14:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pyxem",
"github_project": "kikuchipy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "kikuchipy"
}
JSON
