Web-Based Interactive River Model

This repository contains the source code for the server-side application of the Web-based Interactive River Model.

The live version of this site is available here: https://wirm.walkerenvres.com

The client-side application for this site is available in a separate repo: https://github.com/walkerjeffd/phd-wirm-client

Virtual Environment

Set up a new virtual environment using virtualenv:

pip install virtualenv
virtualenv venv

Activate the virtualenv:

source venv/bin/activate

Dependencies

The dependencies for this application are listed in the requirements.txt file. Note that the django-registration module is no longer actively maintained and may have compatibility issues with Django v1.6. An alternative fork of this module is available at: https://github.com/macropin/django-registration and is currently used on the live site.

To install automatically just use pip:

pip install -r requirements.txt

Configuration

To configure this repository, you must define a series of settings. There are two settings files:

• mysite/mysite/settings/local_template.py: local server
• mysite/mysite/settings/production_template.py: production server

Copy and paste these files without the _template in the name:

cp mysite/mysite/settings/local_template.py mysite/mysite/settings/local.py
cp mysite/mysite/settings/production_template.py mysite/mysite/settings/production.py

Then set the various database configuration, directories, email authentication, etc. settings.

Client-side Code

This Django application uses a client-side application written in backbone, which is stored in a separate repository.

If you update the client-side code, drop the new minified file into the django static folder (e.g. mysite/wirm/static/js/wirm-0.9.3.min.js) and be sure to update the version number in the client template html file (mysite/templates/client.html).

Set Up Database

Use South to create the database, and import the initial fixtures.

cd mysite
python manage.py syncdb
python manage.py migrate
python manage.py loaddata fixtures/parameters.json

Run Locally

To run a local development server simply execute:

python manage.py runserver

Production Server

Use gunicorn to run production server. After following the steps above for activating the virtualenv and setting the configuration, install gunicorn with pip.

pip install gunicorn

Copy upstart configuration file from config/gunicorn.conf to /etc/init/wirm.conf, and then edit the paths if necessary.

sudo cp config/gunicorn.conf /etc/init/wirm.conf
sudo nano /etc/init/wirm.conf

Start the wirm process

sudo start wirm

That should create the wirm.sock file, which nginx then connects to.