Welcome to the Freud example scripts. These jupyter notebooks demonstrate how to utilize the functionality of Freud, from the most basic level to advanced topics. You can view a static version of the notebooks online. For an intereactive exploration, you can launch a dynamic version online, or download the examples and run them on your own system.
$: git clone https://bitbucket.org/glotzer/freud-examples.git
$: cd freud-examples
# create a separate conda environment if necessary
# environment files provided for your convenience
# for OS X/macOS
$: conda env create -n freud-examples -f environment_mac.yml
# for linux
$: conda env create -n freud-examples -f environment_linux.yml
$: jupyter notebook
See Notebook Basics and Running Code for tutorials on using jupyter itself.