{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Installation\n",
    "\n",
    "Freud may be installed via Conda, glotzpkgs, or compiled from source\n",
    "\n",
    "## Conda install\n",
    "\n",
    "To install freud with conda, make sure you have the glotzer channel and conda-private channels installed:\n",
    "\n",
    "```\n",
    "$: conda config --add channels glotzer\n",
    "```\n",
    "\n",
    "Now, install freud:\n",
    "\n",
    "```\n",
    "$: conda install freud\n",
    "# you may also install into a new environment\n",
    "$: conda create -n my_env python=3.5 freud\n",
    "```\n",
    "\n",
    "\n",
    "## Compile from source\n",
    "\n",
    "It's easiest to install freud with a working conda install of the required packages:\n",
    "\n",
    "* python (2.7, 3.3, 3.4, 3.5)\n",
    "* numpy\n",
    "* boost (2.7, 3.3 provided on flux, 3.4, 3.5)\n",
    "* cython (not required, but a correct _freud.cpp file must be present to compile)\n",
    "* tbb\n",
    "* cmake\n",
    "* icu (because of boost for now)\n",
    "\n",
    "You may either make a build directory *inside* the freud source directory, or create a separate build directory somewhere on your system:\n",
    "\n",
    "```\n",
    "mkdir /pth/to/build\n",
    "cd /pth/to/build\n",
    "ccmake /pth/to/freud\n",
    "# adjust settings as needed, esp. ENABLE_CYTHON=ON\n",
    "make install -j6\n",
    "# enjoy\n",
    "```\n",
    "\n",
    "By default, freud installs to the [USER_SITE](https://docs.python.org/2/install/index.html) directory. Which is in\n",
    "`~/.local` on linux and in `~/Library` on mac. `USER_SITE` is on the python search path by default, there is no need to\n",
    "modify `PYTHONPATH`.\n",
    "\n",
    "# Unit Tests\n",
    "\n",
    "Run all unit tests with nosetests in the source directory. To add a test, simply add a file to the `tests` directory,\n",
    "and nosetests will automatically discover it. See http://pythontesting.net/framework/nose/nose-introduction/ for\n",
    "an introduction to writing nose tests.\n",
    "\n",
    "```\n",
    "cd source\n",
    "nosetests\n",
    "```"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": []
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.5.1"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 0
}