birdhousebuilder.recipe.ncwms

Introduction

birdhousebuilder.recipe.ncwms is a Buildout recipe to install and configure ncWMS server with Anaconda. This recipe is used by the Birdhouse project.

Usage

The recipe requires that Anaconda is already installed. You can use the buildout option anaconda-home to set the prefix for the anaconda installation. Otherwise the environment variable CONDA_PREFIX (variable is set when activating a conda environment) is used as conda prefix.

The recipe will install the ncWMS2 and apache-tomcat package from a conda channel in a conda enviroment defined by CONDA_PREFIX. The intallation folder is given by the prefix buildout option. It deploys a Supervisor configuration for Tomcat in ${prefix}/etc/supervisor/conf.d/tomcat.conf. Supervisor can be started with ${prefix}/etc/init.d/supervisord start.

By default ncWMS2 will be available on http://localhost:8080/ncWMS2.

The configuration files of ncWMS2 are in ${prefix}/var/lib/tomcat/conf/ncWMS2.

The recipe depends on birdhousebuilder.recipe.conda, birdhousebuilder.recipe.supervisor and birdhousebuilder.recipe.tomcat.

Supported options

This recipe supports the following options:

anaconda-home

Buildout option pointing to the root folder of the Anaconda installation. Default: $HOME/anaconda.

dynamic_services

List of dynamic service configurations with name and root path to data files. Dynamic service configurations are seperated by space or newlines. Service name and path is seperated by =. Default: outputs=${prefix}/var/lib/pywps/outputs

title

Title for this Web Map Service. Default: Birdhouse ncWMS2 Server

abstract

More details about this Web Map Service. Default: ncWMS2 Web Map Service used in Birdhouse

contact

Name of server administrator. Default: Birdhouse Admin

organization

Organization of server administrator. Default: Birdhouse

url

Web site of the service provider. Default: http://bird-house.github.io/

Cache options:

enablecache

Enable WMS caching: Default: true

inMemorySizeMB

Size in MB of in-memory cache. Default: 256

elementLifetimeMinutes

Life-time of cache elements. Default: 0.0 (unlimited)

To configure tomcat see the options in the tomcat recipe. For example:

http_port

HTTP Port for Tomcat service. Default: 8080

ncwms_password

Enable ncWMS2 admin web interface by setting a password: Default: disabled

Example usage

The following example buildout.cfg installs ncWMS2 with Anaconda and default options:

[buildout]
parts = ncwms

[ncwms]
recipe = birdhousebuilder.recipe.ncwms
organization = Birdhouse
http_port = 8080

An example GetCapabilities URL to access a NetCDF file in outputs (using DATASET param):

http://localhost:8080/ncWMS2/wms?SERVICE=WMS&REQUEST=GetCapabilities&VERSION=1.3.0&DATASET=outputs/malleefowl/tasmax.nc