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 python=3.8
$ 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 .

See the contributing guidelines for how to set up a development installation.