Web-based application written in Django with the following goals:

1. Improve tracking and discoverability of experimental samples and data, both process and characterization data
2. Allow data-driven experimentation by allowing programmable access to data via an embedded iPython notebook
3. Provide project management functionality to help organize experiments and samples
4. Have a clean, consistent user interface to encourage best-practices for use

Emergence uses Node.js for some server-side functionality. Install Node.js and then run npm install -g bower to install Bower.

The easiest way to get Emergence Lab up and running is to build a Docker container. Linux users can install Docker and docker-compose via their package manager. For OS X and Windows users, the Docker Toolbox has everything you need to get started.

After installing Docker and Bower, go to your command line (or Docker shell) and use the following commands:

$ git clone https://github.com/emergence-lab/emergence-lab.git
$ cd emergence-lab
$ bower install
$ cp wbg/secrets.docker.json wbg/secrets.json
$ docker-machine start default  ## OS X and Windows only
$ docker-compose build
$ docker-compose up &
$ docker-compose run web python3 manage.py migrate
$ docker-compose run web python3 manage.py collectstatic --noinput

Create an administrative user by entering:

$ docker-compose run web python3 manage.py createsuperuser

Get your docker machine IP address:

$ docker-machine ip default

Then fire up your web browser and go to <IP Address>:8000 or localhost:8000 and login with the username and password you created. Enjoy!

To shut down Emergence, run docker-compose stop.

To facilitate development, you can change the DEBUG and TEMPLATE_DEBUG settings in wbg/settings/docker.py to True, and edit docker-compose.yml, line 13 with the path to your git repository.

$ pip install -r requirements/development.txt
$ bower install

Copy the template secrets file and edit with database and ldap (optional) configuration.

$ cp wbg/secrets.template.json wbg/secrets.json
$ vim wbg/secrets.json

Tests are run using tox, environments configured are for python 2.7 and flake8. To run them, invoke tox from the command line. If you are using Docker, you can invoke it using:

$ docker exec -it emergencelab_web_1 tox

File uploads use RQ in order to process files in the background. In order for uploaded files to be saved, an RQ worker on the queue default needs to be running. To start the worker, run

$ python manage.py rqworker default &

If you are using Docker, use the following command:

$ docker exec -it emergencelab_web_1 python manage.py rqworker default &