/openECCI

OpenECCI is a Python library for Electron Channelling Contrast Imaging (ECCI) analysis of crystal defects in Scanning Electron Microscope (SEM)

Primary LanguageJupyter NotebookGNU General Public License v3.0GPL-3.0


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.
Deployment PyPI - Version
Documentation Work in progress
Activity PyPI - Downloads
Citation DOI
License GitHub License
Formatter Code style: black

Documentation

Refer to the included Jupyter notebook tutorials for detailed instruction and applications. Demo datasets can be downloaded from openECCI-data repository. The openECCI documentation 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:

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
Xnovo Technology Aps
Sergey Gorelick Monash Centre for Electron Microscopy (MCEM)
Ramaciotti Centre for Cryo-Electron Microscopy
Xiya Fang Monash Centre for Electron Microscopy (MCEM)
Peter Miller Monash Centre for Electron Microscopy (MCEM)