cancerresearchuk-pybossa

Overview

This repository contains all the code needed to install and run the Cancer Research UK funded Citizen Science project within a pybossa server.

Running your own pybossa server using vagrant

Prerequisites

You need to have the following installed

• Vagrant
• VirtualBox
• Git

Clone the pybossa repo

$ git clone --recursive https://github.com/PyBossa/pybossa.git

Clone the CRUK repo

$ git clone --recursive https://github.com/citizenscience/cancerresearchuk-pybossa.git

Clone the CRUK theme repo

$ git clone --recursive https://github.com/PyBossa/cancer-default-theme pybossa/pybossa/themes/cancer-default-theme

Edit the VagrantFile to include the image, styles and scripts needed to run the project

First go to the pybossa folder

$ cd pybossa

Edit VagrantFile.

Inside the block starting withVagrant.configure(VAGRANTFILE_API_VERSION) do |config| before the end statement, add the following two lines. Note that they should be indented to the same degree as the preceeding lines

And note that PATH_TO_DIRECTORY_CONTAINING_THIS_README_FILE refers to the cancerresearchuk-pybossa folder NOT the pybossa folder

    # Config required to link the CRUK static assets to the CRUK project
    config.vm.synced_folder "[PATH_TO_DIRECTORY_CONTAINING_THIS_README_FILE]/assets/trailblazer", "/vagrant/pybossa/themes/default/static/trailblazer"

Edit the settings file to use the CRUK theme

Edit 'settings_local.py'

Add the following line at the end of the file.

THEME = 'cancer-default-theme'

Start Vagrant

$ vagrant up
$ vagrant ssh
$ python run.py

Create an Account on pybossa

• Go to http://localhost:5000
• Click sign in then create a new account
• Enter the details needed to create an account

Take note of your api key

• Click on the user icon in the top right of pybossa
• Choose My Profile from the drop down menu
• Copy and save the API Key shown on your profile page

Upload the CRUK Project to pybossa

Starting from the folder where this readme file is located (normally cancerresearchuk-pybossa)

Note: the location of your python2.7 executable may be different

$ cd project
$ virtualenv -p /usr/bin/python2.7 env
$ source env/bin/activate
$ pip install -r requirements.txt
$ pbs --server http://localhost:5000 --api-key [YOUR_API_KEY_HERE] create_project
$ pbs --server http://localhost:5000 --api-key [YOUR_API_KEY_HERE] add_tasks --tasks-file docs/lung-egfr-metadata.csv
$ pbs --server http://localhost:5000 --api-key [YOUR_API_KEY_HERE] update_project

Go to pybossa website and publish your project

• Click on the user icon in the top right of pybossa
• Choose My projects from the drop down menu
• Click Cancer Research UK - Trailblazer to view project details
• Click Info (top left)
• Click You can now publish it
• Confirm by clicking Yes, publish it
• Click the Start contributing now button to start contributing

Copyright / Licence

Copyright 2016 Cancer Research UK

Source Code License: The GNU Affero General Public License, either version 3 of the License or (at your option) any later version. (See agpl.txt file)

The GNU Affero General Public License is a free, copyleft license for software and other kinds of works, specifically designed to ensure cooperation with the community in the case of network server software.

Documentation is under a Creative Commons Attribution Noncommercial License version 3.