doc: added documentation for vagrant

Author: satra

doc/links_names.txt

@@ -15,6 +15,7 @@
 .. _nibabel: http://nipy.org/nibabel/
 .. _nipype: http://nipy.org/nipype/
 .. _ConnectomeViewer: http://www.connectomeviewer.org/viewer/
+.. _NeuroDebian: http://neuro.debian.net/
 
 .. Documentation tools
 .. _graphviz: http://www.graphviz.org/
@@ -73,6 +74,8 @@
 .. _pythonxy: http://www.pythonxy.com/
 .. _EPD: http://www.enthought.com/products/epd.php
 .. _Traits: http://code.enthought.com/projects/traits/
+.. _Anaconda: https://store.continuum.io/cshop/anaconda/
+.. _Canopy: https://www.enthought.com/products/canopy/
 
 .. Python imaging projects
 .. _PyMVPA: http://www.pymvpa.org
@@ -98,6 +101,9 @@
 .. _xcode: http://developer.apple.com/TOOLS/xcode
 .. _mingw: http://www.mingw.org
 .. _macports: http://www.macports.org/
+.. _Vagrant: http://www.vagrantup.com/
+.. _Docker: http://www.docker.io/
+.. _Virtualbox: https://www.virtualbox.org/
 
 .. Functional imaging labs
 .. _`functional imaging laboratory`: http://www.fil.ion.ucl.ac.uk

doc/quickstart.rst

@@ -11,6 +11,7 @@ Downloading and installing
    :maxdepth: 1
 
    users/install
+   users/vagrant
 
 Beginner's guide
 ================

doc/users/index.rst

@@ -11,6 +11,7 @@
    :maxdepth: 2
 
    install
+   vagrant
 
    interface_tutorial
    caching_tutorial

doc/users/install.rst

@@ -45,17 +45,12 @@ manager.
 Mac OS X
 ~~~~~~~~
 
-The easiest way to get nipype running on Mac OS X is to install EPD_ and then add
-nibabel and nipype by executing::
+The easiest way to get nipype running on Mac OS X is to install Anaconda_ or
+Canopy_ and then add nibabel and nipype by executing::
 
 	easy_install nibabel
 	easy_install nipype
 
-If you are running a 64 bit version of EPD, you will need to compile
-ETS. Instructions for a 64-bit boot mode are available:
-https://gist.github.com/845545
-
-
 From source
 ~~~~~~~~~~~
 
@@ -131,7 +126,7 @@ Dateutil 1.5 -
 
 .. note::
 
-    Full distributions such as pythonxy_ or EPD_ provide the above packages,
+    Full distributions such as Anaconda_ or Canopy_ provide the above packages,
     except Nibabel_.
 
 Strong Recommendations

doc/users/vagrant.rst

@@ -0,0 +1,46 @@
+.. _debug:
+
+======================
+Running Nipype in a VM
+======================
+
+Container technologies (Vagrant_, Docker_) allow creating and manipulating
+lighter weight virtual environments. The Nipype_ source now contains a
+Vagrantfile to launch a Vagrant_ VM.
+
+Requirements:
+
+* Vagrant_
+* Virtualbox_
+
+After you have installed Vagrant and Virtualbox, you simply need to download the
+latest Nipype source and unzip/tar/compress it. Go into your terminal and switch
+to the nipype source directory. Make sure the Vagrantfile is in the directory.
+Now you can execute::
+
+  vagrant up
+
+This will launch and provision the virtual machine.
+
+The default virtual machine is built using Ubuntu Precise 64, linked to the
+NeuroDebian_ source repo and contains a 2 node Grid Engine for cluster
+execution.
+
+The machine has a default IP address of `192.168.100.20` . From the vagrant
+startup directory you can log into the machine using::
+
+  vagrant ssh
+
+Now you can install your favorite software using::
+
+  sudo apt-get install fsl afni
+
+Also note that the directory in which you call `vagrant up` will be mounted
+under `/vagrant` inside the virtual machine.
+
+Please read through Vagrant_ documentation on other features. The python
+environment is built using a `miniconda <http://repo.continuum.io/miniconda/>`_
+distribution. Hence `conda` can be used to do your package management inside the
+VM.
+
+.. include:: ../links_names.txt