pyxem is an open-source python library for crystallographic diffraction microscopy.
This repository contains Jupyter notebooks demonstrating core functionality of the pyXem package.
Note If you are using the demos with a release version of pyxem (e.g. that you have obtained from conda-forge or PyPI) then you should use the corresponding release version of the demos obtained from the Zenodo link above.
Data required for all demos are available here .
Installation
Like many python packages, there are two main routes to installing pyxem, via conda (recommended) and via pip.
Via conda:
$ conda create --name pyxem python=3.8 $ conda activate pyxem $ conda install pyxem --channel conda-forge
Alternatively, via pip:
$ pip install pyxem
If analysis using pyXem forms a part of published work please cite the package as explained here and if these example notebooks are used, please cite the DOI at the top of this page.
If you have problems using any of the notebooks provided here please raise an issue so that we can help.