ebsdlab 0.0.6

The EBSD Lab for Python

ebsdlab

ALPHA-VERSION: TRY AT OWN RISK

Electron Backscatter Diffraction (EBSD) is a microanalytical technique used in scanning electron microscopes to determine the crystallographic orientation of metals at the micrometer scale. This software package provides tools to import, analyze, and visualize the spatially resolved orientation data obtained from EBSD experiments, facilitating microstructural characterization.

Features:

• File formats accepted .ang | .osc | .crc | .txt
• can write .ang for FCC. Others could be added
• fast plotting interaction using virtual mask (only used for plotting)
  • increases speed in intermediate test plots
  • can be removed just before final plotting
• verified with the OIM software and mTex
• heavily tested for cubic
• separate crystal orientation and plotting of it
• some educational plotting
• examples and lots of documentation

Example

EBSD-Inverse Pole Figure (IPF) of polycrystalline Copper with corresponding Pole Figure

Documentation

Documentation on github pages

Installation

You can install ebsdlab using Conda or pip.

Using Conda

Clone the repository:

$ git clone https://github.com/micromechanics/ebsdlab.git ./ebsdlab
$ cd ebsdlab

Create and activate the Conda environment:

The environment.yml file defines the necessary dependencies.

$ conda env create -f environment.yml

After creation, activate the environment:

$ conda activate ebsdlab_env

Install the ebsdlab package: With the Conda environment activated, install the package using pip:

$ python -m pip install .

Using Pip

Set up a Python environment: Using a virtual environment prevents conflicts with other projects.

$ python -m venv venv_python_ebsd  # Create a virtual environment
$ For Linux/macOS: source venv_python_ebsd/bin/activate
$ For Windows: venv_python_ebsd\Scripts\activate

Install the ebsdlab package: This command will install the package and dependencies:

$ pip install git+https://github.com/micromechanics/ebsdlab

After that, the package can be imported and used in Python codes as

>>> from ebsdlab import EBSD
>>> emap = EBSD("Examples/EBSD.ang")
>>> emap.plot(e.CI)

FAQ

What features I do not envision:

• include all crystal symmetries (materials science can mostly live with few)
• other Euler angle definitions than Bunge; materials science does not use those

Future features

• improve cleaning
• grain identification methods
• speed up simulation
• add different symmetries than cubic, and test

Help wanted

• sample files other than copper OIM files
• feedback on tutorials
• any feedback on functionality
• help with cleaning and grain identification