orix

Travis Coveralls docs pypi_version downloads black doi

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

The package defines objects and functions for the analysis of orientations represented as quaternions or 3D rotation vectors accounting for crystal symmetry. Functionality builds primarily on top of numpy and matplotlib and is heavily inspired by the MATLAB package MTEX.

If analysis using orix forms a part of published work please cite the manuscript at the following link. You can also find demos in the orix-demos repo.

orix is released under the GPL v3 license.

Contributing

orix is a community maintained project. We welcome contributions in the form of bug reports, feature requests, code, documentation, and more. These guidelines describe how best to contribute to the pyxem package, but everything there holds for the orix library as well.

Work using orix

Johnstone2020

D. N. Johnstone, B. H. Martineau, P. Crout, P. A. Midgley, A. S. Eggeman, “Density-based clustering of crystal orientations and misorientations and the orix python library,” arXiv preprint:2001.02716 (2020), url: https://arxiv.org/abs/2001.02716.

Installation

orix can be installed from Anaconda, the Python Package Index (pip), or from source, and supports Python >= 3.6.

We recommend you install it in a conda environment with the Miniconda distribution:

$ conda create --name orix-env
$ conda activate orix-env

If you prefer a graphical interface to manage packages and environments, install the Anaconda distribution instead.

Anaconda

Anaconda provides the easiest installation. In the Anaconda Prompt, terminal or Command Prompt, install with:

$ conda install orix --channel conda-forge

If you at a later time need to update the package:

$ conda update orix

pip

To install with pip, run the following in the Anaconda Prompt, terminal or Command Prompt:

$ pip install orix

If you at a later time need to update the package:

$ pip install --upgrade orix

Install from source

To install orix from source, clone the repository from GitHub:

$ git clone https://github.com/pyxem/orix.git
$ cd orix
$ pip install --editable .

Changelog

Changes with each release can be viewed on the GitHub release page.