Difference between revisions of "ML4T Software Installation"

From Quantitative Analysis Software Courses
Jump to navigation Jump to search
m (Changed ML4T.zip to ml4t.zip)
(Added instructions to download data.)
Line 55: Line 55:
 
== Data ==
 
== Data ==
  
TODO: Link to ml4t.zip
+
* Download: [https://s3.amazonaws.com/content.udacity-data.com/courses/ud501/code/ml4t.zip ml4t.zip]
 +
* Unzip it. That should create a <tt>ml4t/</tt> directory with the following contents:
 +
    ml4t
 +
    ├── data
 +
    │   ├── $DJI.csv
 +
    │   ├── $SPX.csv
 +
    │   ├── $VIX.csv
 +
    │   ├── A.csv
 +
    │   ├── AA.csv
 +
    │   ├── AAPL.csv
 +
    │   ├── ...
 +
    │   ├── YHOO.csv
 +
    │   ├── YUM.csv
 +
    │   ├── ZION.csv
 +
    │   └── ZMH.csv
 +
    └── validate_env.py
 +
 
 +
Whenever you need to work on assignments for this class, run your program from within <tt>ml4t/</tt> so that you can access <tt>data/*.csv</tt> using a relative path.
  
 
=== Test installation ===
 
=== Test installation ===
  
Test your environment by running the script <tt>validate_env.py</tt> from the <tt>ml4t/</tt> directory. If it complains, fix the problems, then repeat.
+
Test your environment by running the script <tt>validate_env.py</tt> from the <tt>ml4t/</tt> directory:
 +
    python validate_env.py
 +
 
 +
If it complains, or if any of the installed library versions are older than the desired versions, fix the problems, and then repeat.
 +
 
 +
A clean output from <tt>validate_env.py</tt> is required for MC1-Homework-2.

Revision as of 20:44, 14 August 2015

Overview

Use the following instructions to set up a development environment on your local machine. It should include:

  • The proper version of Python (namely 2.7)
  • Installation of necessary libraries (e.g. NumPy, Pandas, etc.)
  • Installation of historical stock data.

Important note: We use a specific, static dataset for this course, which we will provide. If you download your own data from Yahoo (or elsewhere), you will get wrong answers on assignments.

Required software

Install Python 2.7 (NOT Python 3) and the necessary libraries as instructed below for your favorite platform.

Linux

  • Install Python 2.7 [link]
  • Install pip (in case your Python doesn't come with it) [link]
  • Install virtualenv, virtualenvwrapper (highly recommended) [link]
    • Create a virtual environment to use for this course:
   $ mkvirtualenv ml4t
   $ workon ml4t
    • And then pip install the following within it.
  • NumPy 1.9+, SciPy 0.14+, Pandas 0.16+ [link]

Mac OS X

  • Install Python 2.7 via Homebrew
    • If you don't have it already, first get Homebrew
    • Then: brew install python
  • Install virtualenv, virtualenvwrapper (highly recommended) [link]
    • Create a virtual environment to use for this course:
   $ mkvirtualenv ml4t
   $ workon ml4t
    • And then pip install the following within it.
  • NumPy 1.9+, SciPy 0.14+, Pandas 0.16+ [link]

Windows

  • Install Python 2.7 [link]
  • Install pip (in case your Python doesn't come with it) [link]
  • Install virtualenv, virtualenvwrapper (highly recommended) [link]
    • Create a virtual environment to use for this course:
   C:\Users\Monty> mkvirtualenv ml4t
   C:\Users\Monty> workon ml4t
    • And then pip install the following within it.
  • NumPy 1.9+, SciPy 0.14+, Pandas 0.16+ [link]

Optional software

Data

  • Download: ml4t.zip
  • Unzip it. That should create a ml4t/ directory with the following contents:
   ml4t
   ├── data
   │   ├── $DJI.csv
   │   ├── $SPX.csv
   │   ├── $VIX.csv
   │   ├── A.csv
   │   ├── AA.csv
   │   ├── AAPL.csv
   │   ├── ...
   │   ├── YHOO.csv
   │   ├── YUM.csv
   │   ├── ZION.csv
   │   └── ZMH.csv
   └── validate_env.py

Whenever you need to work on assignments for this class, run your program from within ml4t/ so that you can access data/*.csv using a relative path.

Test installation

Test your environment by running the script validate_env.py from the ml4t/ directory:

   python validate_env.py

If it complains, or if any of the installed library versions are older than the desired versions, fix the problems, and then repeat.

A clean output from validate_env.py is required for MC1-Homework-2.