birdhousebuilder.recipe.thredds 0.3.0
A Buildout recipe to install and configure thredds server with Anaconda.
License: BSD
Keywords: buildout recipe thredds tomcat birdhouse conda anaconda

*******************************
birdhousebuilder.recipe.thredds
*******************************

.. image:: https://travis-ci.org/bird-house/birdhousebuilder.recipe.thredds.svg?branch=master
   :target: https://travis-ci.org/bird-house/birdhousebuilder.recipe.thredds
   :alt: Travis Build

.. contents::

Introduction
************

``birdhousebuilder.recipe.thredds`` is a `Buildout`_ recipe to install and configure `Thredds`_ server with `Anaconda`_.
This recipe is used by the `Birdhouse`_ project. 

.. _`Buildout`: http://buildout.org/
.. _`Anaconda`: http://www.continuum.io/
.. _`Supervisor`: http://supervisord.org/
.. _`Thredds`: http://www.unidata.ucar.edu/software/thredds/current/tds/TDS.html
.. _`Tomcat`: https://tomcat.apache.org/
.. _`Birdhouse`: http://bird-house.github.io/


Usage
*****

The recipe requires that Anaconda is already installed. It assumes that the default Anaconda location is in your home directory ``~/anaconda``. Otherwise you need to set the ``ANACONDA_HOME`` environment variable or the Buildout option ``anaconda-home``.

It installs the ``thredds`` and ``apache-tomcat`` package from a conda channel  in a conda enviroment named ``birdhouse``. The location of the birdhouse environment is ``.conda/envs/birdhouse``. It deploys a `Supervisor`_ configuration for Tomcat in ``~/.conda/envs/birdhouse/etc/supervisor/conf.d/tomcat.conf``. Supervisor can be started with ``~/.conda/envs/birdhouse/etc/init.d/supervisord start``.

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

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 with the root folder of the Anaconda installation. Default: ``$HOME/anaconda``.
   The default location can also be set with the environment variable ``ANACONDA_HOME``. Example::

     export ANACONDA_HOME=/opt/anaconda

   Search priority is:

   1. ``anaconda-home`` in ``buildout.cfg``
   2. ``$ANACONDA_HOME``
   3. ``$HOME/anaconda``

**data_root**
  Root Path of data files (NetCDF) for Thredds. Default: ``~/.conda/envs/birdhouse/var/lib/pywps/output``

**organisation**
  The name of your organisation. Default: Birdhouse

**website**
  The URL of your organisation. Default: None

**allow_wms**
  If set to ``true`` Web Mapping Service will be enabled. Default: ``true``.

**allow_wcs**
  If set to ``true`` Web Coverage Service will be enabled. Default: ``false``.

**allow_nciso**
  If set to ``true`` ISO generator Service will be enabled. Default: ``false``.

To configure tomcat see the options in the `tomcat recipe <https://pypi.python.org/pypi/birdhousebuilder.recipe.tomcat>`_. For example:

**http_port**
    HTTP Port for Tomcat service. Default: 8080

Example usage
=============

The following example ``buildout.cfg`` installs Thredds with Anaconda and given ``data_root`` directory::

  [buildout]
  parts = thredds

  anaconda-home = /home/myself/anaconda

  [thredds]
  recipe = birdhousebuilder.recipe.thredds
  # ncwms
  data_root = /var/lib/thredds/data_root
  organisation = Birdhouse
  allow_wms = true
  # tomcat
  http_port = 8080



Authors
*******

Carsten Ehbrecht ehbrecht at dkrz.de

Changes
*******

0.3.0 (2015-12-17)
==================

* install tomcat.

0.2.3 (2015-12-08)
==================

* remove config files on uninstall.

0.2.2 (2015-06-17)
==================

* using tomcat.content_root().
* cleaned up default configs for thredds.
* allow more configurations.

0.2.1 (2015-04-02)
==================

* updated docs.

0.2.0 (2015-02-24)
==================

* installing in conda enviroment ``birdhouse``.
* using ``$ANACONDA_HOME`` environment variable.
* separation of anaconda-home and installation prefix.

0.1.4 (2014-12-06)
==================

* Don't update conda on buildout update.

0.1.3 (2014-08-27)
==================

* Added web.xml config template.

0.1.2 (2014-08-01)
==================

* Updated documentation.

0.1.1 (2014-07-22)
==================

* Fixed deployment of thredds config.

0.1.0 (2014-07-10)
==================

* Initial Release.