Metadata-Version: 1.1
Name: birdhousebuilder.recipe.ncwms
Version: 0.2.0
Summary: A Buildout recipe to install and configure ncWMS2 server with Anaconda.
Home-page: https://github.com/bird-house/birdhousebuilder.recipe.ncwms
Author: Birdhouse
Author-email: UNKNOWN
License: BSD
Description: *****************************
        birdhousebuilder.recipe.ncwms
        *****************************
        
        .. image:: https://travis-ci.org/bird-house/birdhousebuilder.recipe.ncwms.svg?branch=master
           :target: https://travis-ci.org/bird-house/birdhousebuilder.recipe.ncwms
           :alt: Travis Build
        
        .. contents::
        
        Introduction
        ************
        
        ``birdhousebuilder.recipe.ncwms`` is a `Buildout <http://buildout.org/>`_ recipe to install and configure `ncWMS <http://reading-escience-centre.github.io/edal-java/ncWMS_user_guide.html>`_ server with `Anaconda <http://www.continuum.io/>`_.
        This recipe is used by the `Birdhouse <http://bird-house.github.io/>`_ project. 
        
        
        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 ``ncWMS2`` 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 <http://supervisord.org/>`_ 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 ``ncWMS2`` will be available on http://localhost:8080/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 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_dir**
          Root Path of data files (NetCDF) for ncWMS2 (used in dynamic service ``outputs``). 
          Default: ``~/.conda/envs/birdhouse/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/
        
        **enablecache**
          Enable WMS caching: 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
        
        **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:
        
        .. code-block:: ini 
        
          [buildout]
          parts = ncwms
        
          anaconda-home = /home/myself/anaconda
        
          [ncwms]
          recipe = birdhousebuilder.recipe.ncwms
          organization = Birdhouse
          http_port = 8080
        
        An example ``GetCapabilities`` URL to access for an output 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
        
        
        
        
        Authors
        *******
        
        Carsten Ehbrecht ehbrecht at dkrz.de
        
        Changes
        *******
        
        0.2.0 (2015-12-17)
        ==================
        
        * added tomcat installation.
        * using ncWMS2 2.0.4
        * added empty datasets tag in config.xml template.
        
        0.1.2 (2015-10-22)
        ==================
        
        * added more options: title, abstract, ...
        * renamed option data_root to data_dir
        * updated to ncWMS2 2.0.3
        
        0.1.1 (2015-10-20)
        ==================
        
        * added Dataset config for PyWPS outputs.
        
        0.1.0 (2015-10-19)
        ==================
        
        * Initial Release.
        
Keywords: buildout recipe wms ncwms tomcat birdhouse conda anaconda
Platform: UNKNOWN
Classifier: Framework :: Buildout
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: BSD License
