Installation

Install from GitHub

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

$ git clone https://github.com/roocs/rook.git
$ cd rook

Create Conda environment named rook:

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

Install rook app:

$ pip install -e .
OR
$ make install

For development you can use this command:

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

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

OR

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

The deployed WPS service is by default available on:

http://localhost:5000/wps?service=WPS&version=1.0.0&request=GetCapabilities.

Note

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):

$ lsof -i :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.

Build and run the image directly:

$ docker build -t roocs/rook .
$ docker run --rm -p 5000:5000 roocs/rook

Or use Docker Compose:

$ docker compose build
$ docker compose up

Stop the service with Ctrl+C, then remove the stack with:

$ docker compose down

Use Ansible to deploy rook on your System

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