Skip to main content

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

EBSD of polycrystalline Copper 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

Metadata

Release files for ebsdlab 0.0.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ebsdlab 0.0.6
File Size Uploaded
ebsdlab-0.0.6.tar.gz 32.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ebsdlab 0.0.6
File Interpreter ABI Platform
ebsdlab-0.0.6-py3-none-any.whl Python 3 none any Details

Total release size: 64.0 kB

Release files / ebsdlab-0.0.6.tar.gz

Download URL ebsdlab-0.0.6.tar.gz
Size 32.1 kB
Tags Source
SHA-256 checksum
How to use checksums
22bcacd01bcad598bc053b662cfd1a93373563cf03039b0f7ec1289a50ecf7c9
BLAKE2b-256 checksum
How to use checksums
0a3724e3d5fd5da267bac90bd07045533d47e3b10d02603afa0e1d26f5d3a03b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on May 30, 2025.

Transparency log

Release files / ebsdlab-0.0.6-py3-none-any.whl

Download URL ebsdlab-0.0.6-py3-none-any.whl
Size 31.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
97dd0851664de4a6cabb6880c9d8de80820d8a363bbb5661a16958b87255bfcc
BLAKE2b-256 checksum
How to use checksums
6b70def58db7a6ee967923f39447f1751d67c77a308e219f38d1660385164690
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on May 30, 2025.

Transparency log

Release history Release notifications | RSS feed

This release

0.0.6 This release

2 release files

0.0.3

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page