QSToolKit Installation Guide Mac

From Quantwiki
Jump to: navigation, search


For consistence and convenience, we do not recommend QSTK installation on Mac, instead we suggest you to follow Ubuntu_Installation_Guide_Mac to install Ubuntu and QSToolKit_Installation_Guide_Ubuntu to install QSTK. However, if you insist on installing QSTK on Mac, we also provide installation guide as follows, but cannot guarantee it works for everyone.

System Requirements

Make sure your system meets these requirements:

  • Operating system: QSTK requires MacOS 10.7 10.8 10.9 (it has been tested successfully on these)
  • RAM: 2GB.
  • Disk space: 2GB

Step 1: Install Command Line Tools

  • Open terminal, type “xcode-select --install” in terminal (without quotes)
  • A pop-up windows will appear asking you about install tools, choose install tools, wait install to finish

Step 2: Install Homebrew

Open the terminal application by using Command + Space and then typing terminal.

ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

This will install homebrew in /usr/local/bin. If you have a previous install of MacPorts or Fink, it will suggest that you move it aside. I recommend that you follow that suggestion. Now you need to make sure everything uses homebrew versions instead of the default installation. Example: we want to use homebrew's python instead of the default version by Apple.

echo 'export PATH="/usr/local/bin:$PATH"' >> ~/.bash_profile

Now RESTART the terminal or source ~/.bash_profile to edit the PATH variable. Then run the command below to make sure everything works.

brew doctor

Step 3: Installing QSTK and all dependencies

curl -L https://raw.githubusercontent.com/QuantSoftware/QuantSoftwareToolkit/master/MacInstallation.sh | bash

Step 4: Download Examples and Validate Installation

cd ~/QSTK
curl -O https://raw.githubusercontent.com/weiyialanchen/MacInstallation/master/Examples.zip
unzip Examples.zip

Now we have downloaded the examples for QSTK. If the unzip created an Examples directory, just use `cd Examples`. Lets validate the installation first to make sure everything is in place.

cd Examples
python Validation.py

Now that the validation is a success. Lets test drive QSTK.

python Basic/tutorial1.py

You should see pdfs created in the ~/QSTK directory. Which can be opened using finder or using the open command.

If all fails

  • Go to the piazza forums and ask for help! There are smart people there ready to help.