  
  Section of Biomedical Image Analysis
  Goddard Building
  3701 Hamilton Walk, 6th Floor
  Philadelphia, PA 19104

  Web:   http://www.cbica.upenn.edu/sbia/
  Email: sbia-software at uphs.upenn.edu

  Copyright (c) 2016 University of Pennsylvania. All rights reserved.
  See http://www.cbica.upenn.edu/sbia/software/license.html or COPYING file.



INTRODUCTION
============

  This is the installation guide for MOE software. Please make sure you have the required 
  dependencies before proceeding.

Quick Summary of Installation
=============================

This software has been primarily implemented for Linux operating systems. It is implemented in Python.

----------------
 Dependencies
----------------
- Python 2.7.9
- Python library numpy 1.7.2
- Python library scipy 0.15.1
- Python library pandas 0.16.2
- Python library sklearn 0.15

Make sure all dependencies are met before proceeding with install.

-------------------------------------
Generating standalone executables
-------------------------------------
1) Within the src/  directory, run makeAll.py  with the location of the install directory as the argument:

./makeAll.py <installDir>

makeAll creates four folders within installDir - bin, libexec, share and doc.
bin/ contains the executible, which is a symlink to MOE.py in libexec/.
libexec/ has all python scripts.
share/ has the test data.
doc/ has the doxygen documentation.

2) Add the install directory to your path by running the following command. 

Replace ${installDir} with the location of the install directory from step 1 above.

export PATH=${PATH}:${installDir}/bin/

----------------------------
Code documentation
----------------------------

makeAll generates doxygen documentation.
The documentation is built in "${installDir}/doc/*". Open "doc/index.html" in your favorite browser to begin.
