Development

Development

This is a guide on getting started developing jem-data. It assumes you have a python development environment setup using pip and virtualenv.

Get the source

First up, you will need to download the source:

git clone git@github.com:icmurray/jem-data.git jem-data

This will download the source into ./jem-data.

Create a new virtualenv

Before installing any software or dependencies, it's recommended you should create a new python virtualenv to work within:

mkvirtualenv jem_data

After which, you should see (jem-data) prefixed to your bash prompt, for example:

(jem-data)[1004] ian@neon~/scratch $>

Installing dependencies

To install the dependencies requried to run the application:

pip install -r requirements.txt

After which, it's recommended you also install the application itself in an editable form with:

pip install -e ./

At this point, you should be able to run both the server simulator and the benchmarking script.

Running tests

It's also recommended that you run and check the project's unit tests. To do so, you will need to install the test dependencies:

pip install -r ./pip-requirements-test.txt

You should now be able to run the tests:

nosetests

All the tests should pass.