Freud may be installed via Conda, glotzpkgs, or compiled from source
To install freud with conda, make sure you have the glotzer channel and conda-private channels installed:
$: conda config --add channels glotzer
Now, install freud:
$: conda install freud
# you may also install into a new environment
$: conda create -n my_env python=3.5 freud
It's easiest to install freud with a working conda install of the required packages:
You may either make a build directory inside the freud source directory, or create a separate build directory somewhere on your system:
mkdir /pth/to/build
cd /pth/to/build
ccmake /pth/to/freud
# adjust settings as needed, esp. ENABLE_CYTHON=ON
make install -j6
# enjoy
By default, freud installs to the USER_SITE directory. Which is in
~/.local
on linux and in ~/Library
on mac. USER_SITE
is on the python search path by default, there is no need to
modify PYTHONPATH
.
Run all unit tests with nosetests in the source directory. To add a test, simply add a file to the tests
directory,
and nosetests will automatically discover it. See http://pythontesting.net/framework/nose/nose-introduction/ for
an introduction to writing nose tests.
cd source
nosetests