Skip to content

james-whiteside/ebsd-utils

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Utilities for processing EBSD data

This project provides utilities for analysing EBSD data, including determination of GND densities, channelling fractions, and orientation clusters. The code is designed to read in data in CSV files as formatted by Thermo Fisher’s Pathfinder acquisition software, but could be modified to work with data of other formats.

This codebase is currently undergoing a major refactor, the goals of which are to:

  • Improve the overall clarity of the code to make it easier to contribute to. [in progress]
  • Add type hints across the codebase to aid in additions and refactors. [complete]
  • Introduce proper segregation of responsibilities across modules. [complete]
  • Introduce better data interchange formats between functional components. [complete]
  • Make most settings configurable via config files. [complete]
  • Add a central CLI control program from which all analysis functions can be accessed. [planned]
  • Properly document all functions with respect to equations featured in the accompanying thesis. [in progress]
  • Rename variables and functions for improved clarity and ensure PEP 8 compliance. [in progress]

This code is provided without any guarantees, as set out in the licence. During the refactoring process, this particularly applies, and there is likely to be code that will not function correctly, if at all. Contributions will not be accepted during this period.

Contributors:

  • O.J. Whiteside, primary author.
  • Dr G. Höbler, author of original code to calculate channelling fractions.

About

Utilities for processing EBSD data

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages