IQSS / eyeData

Adaptive Visualizations of Research Data

eyeData

Repo for DPSI Team eyeData. This project includes a set of tools for searching and exploring survey data on Dataverse.

---

Local Install (on OS X and Windows 8.1)

This is a quick checklist to install eyeData on an OS X or Windows 8.1 machine. Currently, it installs the twoscoops project template for Django 1.6, including creating a sqlite database and running a skeleton site.

Install pip

• use sudo if needed
• if on Windows, make sure python is installed.

Install virtualenvwrapper

• depends on pip
• if on windows, either install virtualenvwrapper-win-1.1.5 or cygwin.
• remember to set the (shell startup file)[http://virtualenvwrapper.readthedocs.org/en/latest/install.html#shell-startup-file]

export WORKON_HOME=$HOME/.virtualenvs
export PROJECT_HOME=$HOME/Devel
source /usr/local/bin/virtualenvwrapper.sh

or, on windows, this might be helpful.

Pull down the eyeData repository

• Use the mac client if desired or windows client

Setup on the local machine

cd into the eyeData repository

cd ~\eyeData

Install the virtualenv and the requirements

This may take a minute or two. Xcode needs to be installed.

mkvirtualenv eyedata
pip install -r requirements/local.txt

If you run into Xcode (or other errors) when running the install, google it. Sometimes the Xcode license agreement hasn't been accepted

Configure settings (still in ~\eyeData)

• Edit the postactivate script for the virtualenvwrapper.

vim $VIRTUAL_ENV/bin/postactivate

On windows:

vim %VIRTUAL_ENV%\Scripts\activate.bat

'vim' may be any text editor

• add these lines to the postactivate file and save the file

export DJANGO_DEBUG=True
export DJANGO_SETTINGS_MODULE=eyedata.settings.local

On windows:

set "DJANGO_DEBUG=True"
set "DJANGO_SETTINGS_MODULE=eyedata.setings.local"

• Test the 'postactivate' script from the command line

deactivate
workon eyedata
echo $DJANGO_SETTINGS_MODULE

On Windows, use:

echo %DJANGO_SETTINGS_MODULE%

You should see eyedata.settings.local

Sync the database (still in ~\eyeData)

cd eyedata
python manage.py syncdb

• Follow the prompts to create a superuser, create tables, etc.

Run the test server (still in ~\eyeData\eyedata)

python manage.py runserver

• Feel grateful to be alive

Edit the template files

• Location ~\eyeData\eyedata\templates

• base.html is the over-arching template

Working with the project (post installation)

cd ~\eyeData\eyedata
workon eyedata
python manage.py runserver

Vagrant environment

This git repository contains a Vagrant environment that is used to mimic the Linux server that hosts the application in production. If you have Vagrant and VirtualBox installed you should be able to run vagrant up see the running eyeData app at http://localhost:8000 (but you'll need to set "DEBUG = True" in eyedata/eyedata/settings/production.py).