orix#

orix is an open-source Python library for analysing orientations and crystal symmetry.

The package defines objects and functions for the analysis of orientations accounting for crystal symmetry. Functionality builds primarily on NumPy and Matplotlib, and is heavily inspired by the MATLAB package MTEX.

Installation#

orix can be installed with pip or conda:

pip install orix

conda install orix -c conda-forge

Further details are available in the installation guide.

Learning resources#

card-img-top
Examples

Short recipies to common tasks using orix.

card-img-top
Tutorials

In-depth guides for using orix.

card-img-top
API reference

Descriptions of functions, modules, and objects in orix.

Contributing#

orix is a community project maintained for and by its users. There are many ways you can help!

Citing orix#

If analysis using orix forms a part of published work please cite the paper (journal, arXiv) and the package itself via the Zenodo DOI: https://doi.org/10.5281/zenodo.3459662.

orix is released under the GPL v3 license.

Work using orix#

  • P. Harrison, X. Zhou, S. M. Das, P. Lhuissier, C. H. Liebscher, M. Herbig, W. Ludwig, E. F. Rauch: Reconstructing Dual-Phase Nanometer Scale Grains within a Pearlitic Steel Tip in 3D through 4D-Scanning Precession Electron Diffraction Tomography and Automated Crystal Orientation Mapping, Ultramicroscopy 113536 (2022) (journal).

  • N. Cautaerts, P. Crout, H. W. Ånes, E. Prestat, J. Jeong, G. Dehm, C. H. Liebscher: Free, flexible and fast: Orientation mapping using the multi-core and GPU-accelerated template matching capabilities in the python-based open source 4D-STEM analysis toolbox Pyxem, Ultramicroscopy 113517 (2022) (journal, arXiv).

  • D. N. Johnstone, B. H. Martineau, P. Crout, P. A. Midgley, A. S. Eggeman: Density-based clustering of crystal (mis)orientations and the orix Python library, Journal of Applied Crystallography 53(5) (2020) (journal, arXiv).