Installation guide¶

System requirements¶

Let us start with the installation of the system dependencies. Django and other python requirements will be installed locally inside the project using virtualenv.

Command below will install virtualenv, postgresql, geospatial libraries, PostGIS and rabbitmq-server:

user@home:~$ sudo apt-get install python-virtualenv postgresql-9.1 binutils
libproj-dev gdal-bin postgresql-server-dev-9.1
rabbitmq-server libavcodec-dev libavformat-dev libswscale-dev libjpeg-dev python-dev

Before installing postgis, check which version is available at your system:

user@home:~$ sudo apt-get install -s postgresql-9.1-postgis | grep postgis

It may be the case that your version is 1.5.x or lower.

You can either install the available version same as before:

user@home:~$ sudo apt-get install postgresql-9.1-postgis

Or you could try to find the way to obtain PostGIS 2.x for your system:

Preparing PostgreSQL database¶

In this section we will prepare the database for handling the geospatial data, as well as setup some basic user privileges. Before we downloading Trapper perform the following actions in a console:

Now we will create a new postgresql user named trapper.

user@home:~$ adduser trapper
(use unix defaults here)
user@home:~$ su - postgres
postgres@home:~$ psql
postgres=# CREATE USER trapper WITH PASSWORD 'trapper';
CREATE ROLE
postgres=# \q

Snipplet above does the following:

1. Creates a new unix user called trapper
2. Switches to postgres user
3. Runs psql command-line interface and connects to a template1 database
4. Creates the postgresql user trapper
5. \q exists the psql

Now we will create a database and set up the postgis extension on it:

user@home:~$ su - postgres
postgres@home:~$ psql
postgres=# CREATE DATABASE trapper_db OWNER trapper;
CREATE DATABASE
postgres=# GRANT ALL PRIVILEGES ON DATABASE trapper_db TO trapper;
GRANT
postgres=# \c trapper_db
You are now connected to database "trapper_db" as user "postgres"
trapper_db=# CREATE EXTENSION postgis;
CREATE EXTENSION
trapper_db=# \q

Snipplet above does the following:

1. Switches to a postgres user
2. Runs psql command-line interface and connects to a template1 database
3. Creates the database named trapper_db and makes trapper its owner
4. Connects to the newly created database
5. installs the postgis extension (required for the geospatial features of Trapper)
6. \q exists the psql

Preparing the project¶

Next step is cloning the repository and installing python the requirements.

user@home:~$ git clone https://github.com/TrapperTeam/Trapper
user@home:~$ cd Trapper/
user@home:~$ virtualenv env
user@home:~$ ./env/bin/pip install -r requirements.txt

Running Trapper¶

The project is now set up and ready to use. Initialize the database along with the test data and run the server:

user@home:~$ ./setup_database.sh
user@home:~$ ./run_server.sh

Additionally, execute a celery worker in a separate shell:

user@home:~$ ./run_celery.sh

Extra: Generating this documentation¶

Since Trapper is developed using virtualenv, it may be difficult to generate this documentation using sphinx-build that’s installed system-wide. In order to resolve that simply perform the following steps:

user@home:~$ cd $TRAPPER_ROOT
user@home:~$ which sphinx-build
/usr/bin/sphinx-build (or other system path)
user@home:~$ source ./env/bin/activate
user@home:~$ which sphinx-build
$TRAPPER_ROOT/env/bin/sphinx-build

After that you should be able to generate this document without problems:

user@home:~$ cd $TRAPPER_ROOT/docs/
user@home:~$ make html

After that, this website will reside in $TRAPPER_ROOT/docs/_build directory.