Skip to content


Repository files navigation


freud examples

Welcome to the freud example scripts. These Jupyter notebooks demonstrate how to utilize the functionality of freud. These notebooks may be launched interactively on Binder or downloaded and run on your own system.

git clone
cd freud-examples
jupyter notebook

See Notebook Basics and Running Code for tutorials on using Jupyter itself.

To test the notebooks and ensure that they all run, use:

python -m pytest -v --nbval --nbval-lax --ignore=archive/