<div align="center">
<a href="https://github.com/IMBalENce/openECCI">
<img width="60%" src="https://github.com/IMBalENce/openECCI/raw/main/images/logo/banner.png">
</a>
</div>
<br>
OpenECCI [open-e-ki] is a Python library for Electron Channelling Contrast Imaging (ECCI) analysis of crystal defects in Scanning Electron Microscope (SEM) by guiding precise stereo-tilt of the specimen to the preferable orientations.
<br>
| Deployment |  |
| :- | :- |
| **Activity** | Work in progress |
| **Citation** | [](https://zenodo.org/doi/10.5281/zenodo.11183729) |
| **License** | [](https://opensource.org/licenses/GPL-3.0) |
## Documentation
Refer to the included [Jupyter notebook tutorials](https://github.com/IMBalENce/openECCI/tree/main/tutorials) for detailed instruction and applications. Demo datasets can be downloaded from [openECCI-data](https://github.com/IMBalENce/openECCI-data) repository. The [openECCI documentation](https://openecci-tutorials.readthedocs.io/en/latest/#) page is currently under development. Stay tuned for more information. More code examples, and a detailed workflow tutorial paper will be updated soon.
## Installation
Create a new conda environment
```
conda update conda
conda create -n openecci python=3.10
conda activate openecci
```
Install openECCI with `pip`:
```bash
pip install openECCI
```
or you can install from source:
```
git clone https://github.com/IMBalENce/openECCI
cd openECCI
pip install .
```
If you want to create an editable install:
```
pip install -e .
```
## Citing openECCI
If you are using openECCI in your scientific research, please help our scientific
visibility by citing the Zenodo DOI: https://doi.org/10.5281/zenodo.11183730.
## Contributors
| | |
| :- | :- |
|Zhou Xu | Monash Centre for Electron Microscopy (MCEM) |
| HÃ¥kon Wiik Ã…nes | Norwegian University of Science and Technology <br> Xnovo Technology Aps |
| Sergey Gorelick | Monash Centre for Electron Microscopy (MCEM) <br> Ramaciotti Centre for Cryo-Electron Microscopy |
| Xiya Fang | Monash Centre for Electron Microscopy (MCEM) |
| Peter Miller | Monash Centre for Electron Microscopy (MCEM) |
Raw data
{
"_id": null,
"home_page": "https://github.com/IMBalENce/openECCI",
"name": "openECCI",
"maintainer": "Zhou Xu",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "zhou.xu@monash.edu",
"keywords": "ECCI, electron channelling contrast imaging, ECP, electron channeling pattern, EBSD, electron backscatter diffraction, RKD, reflected kikuchi diffraction, SEM, scanning electron microscopy, kikuchi pattern, dislocation, defect analsysis",
"author": "openECCI developers",
"author_email": "zhou.xu@monash.edu",
"download_url": "https://files.pythonhosted.org/packages/e9/2c/40b16ba2859de5328131a59fbf6094ff9d220a7b02eaba91e4262964a6b6/openECCI-0.1.0.tar.gz",
"platform": "\"Linux\"",
"description": "<div align=\"center\">\r\n <a href=\"https://github.com/IMBalENce/openECCI\">\r\n <img width=\"60%\" src=\"https://github.com/IMBalENce/openECCI/raw/main/images/logo/banner.png\">\r\n </a>\r\n</div>\r\n<br>\r\nOpenECCI [open-e-ki] is a Python library for Electron Channelling Contrast Imaging (ECCI) analysis of crystal defects in Scanning Electron Microscope (SEM) by guiding precise stereo-tilt of the specimen to the preferable orientations. \r\n<br> \r\n\r\n| Deployment |  | \r\n| :- | :- |\r\n| **Activity** | Work in progress |\r\n| **Citation** | [](https://zenodo.org/doi/10.5281/zenodo.11183729) |\r\n| **License** | [](https://opensource.org/licenses/GPL-3.0) |\r\n\r\n## Documentation\r\n\r\nRefer to the included [Jupyter notebook tutorials](https://github.com/IMBalENce/openECCI/tree/main/tutorials) for detailed instruction and applications. Demo datasets can be downloaded from [openECCI-data](https://github.com/IMBalENce/openECCI-data) repository. The [openECCI documentation](https://openecci-tutorials.readthedocs.io/en/latest/#) page is currently under development. Stay tuned for more information. More code examples, and a detailed workflow tutorial paper will be updated soon.\r\n\r\n## Installation\r\n\r\nCreate a new conda environment\r\n```\r\nconda update conda\r\nconda create -n openecci python=3.10 \r\nconda activate openecci\r\n``` \r\nInstall openECCI with `pip`:\r\n```bash\r\npip install openECCI\r\n```\r\n\r\nor you can install from source:\r\n```\r\ngit clone https://github.com/IMBalENce/openECCI\r\ncd openECCI\r\npip install .\r\n```\r\nIf you want to create an editable install:\r\n```\r\npip install -e .\r\n```\r\n\r\n## Citing openECCI\r\n\r\nIf you are using openECCI in your scientific research, please help our scientific\r\nvisibility by citing the Zenodo DOI: https://doi.org/10.5281/zenodo.11183730.\r\n\r\n## Contributors\r\n| | |\r\n| :- | :- |\r\n|Zhou Xu | Monash Centre for Electron Microscopy (MCEM) |\r\n| H\u00c3\u00a5kon Wiik \u00c3\u2026nes | Norwegian University of Science and Technology <br> Xnovo Technology Aps |\r\n| Sergey Gorelick | Monash Centre for Electron Microscopy (MCEM) <br> Ramaciotti Centre for Cryo-Electron Microscopy |\r\n| Xiya Fang | Monash Centre for Electron Microscopy (MCEM) |\r\n| Peter Miller | Monash Centre for Electron Microscopy (MCEM) |\r\n",
"bugtrack_url": null,
"license": "GPLv3+",
"summary": "An open source python package for guiding Electron Channelling Contrast Imaging (ECCI)in Scanning Electron Microscopes (SEM).",
"version": "0.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/IMBalENce/openECCI/issues",
"Download": "https://pypi.python.org/pypi/open_ecci",
"Homepage": "https://github.com/IMBalENce/openECCI",
"Source Code": "https://github.com/IMBalENce/openECCI"
},
"split_keywords": [
"ecci",
" electron channelling contrast imaging",
" ecp",
" electron channeling pattern",
" ebsd",
" electron backscatter diffraction",
" rkd",
" reflected kikuchi diffraction",
" sem",
" scanning electron microscopy",
" kikuchi pattern",
" dislocation",
" defect analsysis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2cc2a8f9dcef98f282cb730eef347f1e88df898f05363f74f09ff9d99069d304",
"md5": "b6ca06016cee03c53a0c876988e14b45",
"sha256": "b250b3aaada6272fa35650ce9f7266643485137510bd735432d5b562f9ee6ca3"
},
"downloads": -1,
"filename": "openECCI-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b6ca06016cee03c53a0c876988e14b45",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 44976,
"upload_time": "2024-05-15T01:30:26",
"upload_time_iso_8601": "2024-05-15T01:30:26.105396Z",
"url": "https://files.pythonhosted.org/packages/2c/c2/a8f9dcef98f282cb730eef347f1e88df898f05363f74f09ff9d99069d304/openECCI-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e92c40b16ba2859de5328131a59fbf6094ff9d220a7b02eaba91e4262964a6b6",
"md5": "14070f3763262a68aecb479fce3c32f7",
"sha256": "afc61ce3836abf21d21e16b934c8eefbbe422bdaee47127193b90026160b8771"
},
"downloads": -1,
"filename": "openECCI-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "14070f3763262a68aecb479fce3c32f7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 40853,
"upload_time": "2024-05-15T01:30:28",
"upload_time_iso_8601": "2024-05-15T01:30:28.548024Z",
"url": "https://files.pythonhosted.org/packages/e9/2c/40b16ba2859de5328131a59fbf6094ff9d220a7b02eaba91e4262964a6b6/openECCI-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-15 01:30:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "IMBalENce",
"github_project": "openECCI",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "openecci"
}
JSON
