Install from Conda


TODO: Prepare Conda package.

Install from GitHub

Check out code from the rook GitHub repo and start the installation:

$ git clone
$ cd rook

Create Conda environment named rook:

$ conda env create -f environment.yml
$ source activate rook

Install rook app:

$ pip install -e .
make install

For development you can use this command:

$ pip install -e ".[dev]"
$ make develop

Configure roocs

rook is using daops for the operations. It needs a roocs.ini configuration file. You can overwrite the defaults by setting the environment variable ROOCS_CONFIG.

$ export ROOCS_CONFIG=~/.roocs.ini

There is an example in etc/sample-roocs.ini.

For more information on the configuration settings, see

Start rook PyWPS service

After successful installation you can start the service using the rook command-line.

$ rook --help # show help
$ rook start  # start service with default configuration


$ rook start --daemon # start service as daemon
loading configuration
forked process id: 42

The deployed WPS service is by default available on:



Remember the process ID (PID) so you can stop the service with kill PID.

You can find which process uses a given port using the following command (here for port 5000):

$ netstat -nlp | grep :5000

Check the log files for errors:

$ tail -f  pywps.log

… or do it the lazy way

You can also use the Makefile to start and stop the service:

$ make start
$ make status
$ tail -f pywps.log
$ make stop

Run rook as Docker container

You can also run rook as a Docker container.


TODO: Describe Docker container support.

Use Ansible to deploy rook on your System

Use the Ansible playbook for PyWPS to deploy rook on your system.