INSTALL

How to install RainforestCluster

Prerequisites

Supported Operating Systems: Linux, Mac OSX, Windows using Cygwin (does not support PuTTY or native windows cmd)

Python Version: 2.7.x
Packages: boto (version 2.24.0 or better, newest version recommended)
Install boto through pip, easy_install, or by visiting: http://boto.readthedocs.org/en/latest/getting_started.html

Installation Instructions

Simply copy the rainforestcluster directory given here to ~/.rainforestcluster
The directory structure should look like ~/.rainforestcluster/..._config.ini ~/.rainforestcluster/clusters/... ~/.rainforestcluster/bin/...
You can add ~/.rainforestcluster/bin/ to your PATH for convenience

Then, you will need to copy one of:
    default_config.ini (all the defaults)
    minimal_config.ini (minimal number of options to run)
    example_config.ini (all extra options, fully documented)
To config.ini in ~/.rainforestcluster/ and set these values in the new config.ini file: (no spaces, dashes, quotes, brackets etc.)
aws_access_key = <aws access key>
aws_secret_key = <aws secret key>

You will also need to set up at least one keypair:
[Keypair your_amazon_ec2_key]
keypair_location = /home/your_username/.ssh/your_amazon_ec2_key.pem

And set that keypair to at least one cluster template:
keypair = your_amazon_ec2_key

Remember that the keypair name must match the name on Amazon!

The other settings in the config file are optional, but recommended to check out.