Setting up a development installation

You need a fork of the repository in order to make changes to kikuchipy.

Make a local copy of your forked repository and change directories:

git clone https://github.com/your-username/kikuchipy.git
cd kikuchipy

Set the upstream remote to the main kikuchipy repository:

git remote add upstream https://github.com/pyxem/kikuchipy.git

We recommend installing in a conda environment with the Miniconda distribution:

conda create --name kp-dev
conda activate kp-dev

Then, install the required dependencies while making the development version available globally (in the conda environment):

pip install --editable ".[dev]"

This installs all necessary development dependencies, including those for running tests and building documentation. Further details are available in the Dependencies section of the installation guide.