Skip to content

Commit

Permalink
using glossary for anaconda, pywps references
Browse files Browse the repository at this point in the history
  • Loading branch information
@cehbrecht
cehbrecht committed Mar 13, 2015
1 parent 820cdd7 commit 647f163
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 8 deletions.
18 changes: 16 additions & 2 deletions docs/source/glossary.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,15 @@ Glossary
.. glossary::
:sorted:

OGC
Open Geospatial Consortium
The *Open Geospatial Consortium (OGC)* is an international voluntary consensus standards organization, originated in 1994.
https://en.wikipedia.org/wiki/Open_Geospatial_Consortium

WPS
Web Processing Service
WPS is an open standard to search and run processes with a simple web-based interface.
See: `What is WPS? <http://geoprocessing.info/wpsdoc/Concepts#what>`_.
WPS is an open standard to search and run processes with a simple web-based interface.
See: `What is WPS? <http://geoprocessing.info/wpsdoc/Concepts#what>`_.

WSGI
WSGI is an interface specification by which server and application communicate.
Expand All @@ -32,3 +37,12 @@ Glossary
Buildout
*Buildout* is a Python-based build system for creating, assembling and deploying applications from multiple parts, some of which may be non-Python-based. It lets you create a buildout configuration and reproduce the same software later.
http://www.buildout.org/en/latest/

PyWPS
*Python Web Processing Service* is an implementation of the :term:`Web processing Service` standard from :term:`Open Geospatial Consortium`.
http://pywps.wald.intevation.org/

Anaconda
Anaconda Python distribution
Python distribution for large-scale data processing, predictive analytics, and scientific computing.
http://www.continuum.io/
11 changes: 5 additions & 6 deletions docs/source/installation.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ Installation
:local:
:depth: 2

Birdhouse consists of several components like :ref:`Malleefowl <malleefowl:introduction>` and :ref:`Emu <emu:introduction>`. Each of them can be installed individually. The installation is done using the Python-based build system :term:`Buildout`. Most of the dependencies are maintained in the `Anaconda Python distribution`_. For convience each Birdhouse component has a `Makefile` to ease the installation so you don't need to know how to call the Buildout build tool.
Birdhouse consists of several components like :ref:`Malleefowl <malleefowl:introduction>` and :ref:`Emu <emu:introduction>`. Each of them can be installed individually. The installation is done using the Python-based build system :term:`Buildout`. Most of the dependencies are maintained in the :term:`Anaconda Python distribution`. For convience each Birdhouse component has a `Makefile` to ease the installation so you don't need to know how to call the Buildout build tool.

Requirements
------------

Birdhouse uses `Anaconda Python distribution`_ for most of the dependencies. If Anaconda is not already installed it will be installed during the installation process. Anaconda has packages for Linux, MacOSX and Windows. But not all packages used by Birdhouse are already available in the default package channel of Anaconda. The missing packages are supplied by Birdhouse on Binstar. But we currently maintain only packages for Linux 64-bit and partly for MacOSX.
Birdhouse uses :term:`Anaconda Python distribution` for most of the dependencies. If Anaconda is not already installed it will be installed during the installation process. Anaconda has packages for Linux, MacOSX and Windows. But not all packages used by Birdhouse are already available in the default package channel of Anaconda. The missing packages are supplied by Birdhouse on Binstar. But we currently maintain only packages for Linux 64-bit and partly for MacOSX.

So the short answer to the requirements is: you need a **Linux 64-bit installation**.

Expand Down Expand Up @@ -52,7 +52,7 @@ On the WPS server side we have:
Nginx, gunicorn and supervisor
------------------------------

Birdhouse setups a `PyWPS`_ server (and also the Phoenix web application) using :term:`Buildout`. We use the :term:`Gunicorn` HTTP application server (similar to Tomcat for Java servlet applications ) to run these web applications with the :term:`WSGI` interface. In front of the Gunicorn application server we use the :term:`Nginx` HTTP server (similar to Apache web server). All these web services are started/stopped and monitored by a :term:`Supervisor` service.
Birdhouse setups a :term:`PyWPS` server (and also the Phoenix web application) using :term:`Buildout`. We use the :term:`Gunicorn` HTTP application server (similar to Tomcat for Java servlet applications ) to run these web applications with the :term:`WSGI` interface. In front of the Gunicorn application server we use the :term:`Nginx` HTTP server (similar to Apache web server). All these web services are started/stopped and monitored by a :term:`Supervisor` service.

See the following image on how this looks like:

Expand Down Expand Up @@ -109,7 +109,7 @@ Alternative package manager to Anaconda are for example `Homebrew <http://brew.s
Buildout Recipes provided by Birdhouse
--------------------------------------

:term:`Buildout` has a plugin mechanism to extend the build tool functionality with `recipes <http://www.buildout.org/en/latest/docs/recipe.html>`_. Birdhouse provides a Buildout recipe to install Anaconda packages. There is also a set of recipes to set up Web Processing Service with PyWPS, Nginx, gunicorn and supervisor. All these `Buildout recipes are on GitHub <https://github.com/bird-house?query=birdhousebuilder.recipe>`_ and can be `found on PyPi <https://pypi.python.org/pypi?%3Aaction=search&term=birdhousebuilder.recipe&submit=search>`_.
:term:`Buildout` has a plugin mechanism to extend the build tool functionality with `recipes <http://www.buildout.org/en/latest/docs/recipe.html>`_. Birdhouse provides a Buildout recipe to install Anaconda packages. There is also a set of recipes to set up Web Processing Service with PyWPS, Nginx, Gunicorn and Supervisor. All these `Buildout recipes are on GitHub <https://github.com/bird-house?query=birdhousebuilder.recipe>`_ and can be `found on PyPi <https://pypi.python.org/pypi?%3Aaction=search&term=birdhousebuilder.recipe&submit=search>`_.

Here is the list of currently used Buildout recipes by Birdhouse:

Expand All @@ -120,9 +120,8 @@ Here is the list of currently used Buildout recipes by Birdhouse:
* `birdhousebuilder.recipe.supervisor <https://pypi.python.org/pypi/birdhousebuilder.recipe.supervisor>`_: A Buildout recipe to install and configure supervisor for Anaconda.
* `birdhousebuilder.recipe.docker <https://pypi.python.org/pypi/birdhousebuilder.recipe.docker>`_: A Buildout recipe to generate a Dockerfile for Birdhouse applications.

.. _`Anaconda Python distribution`: http://www.continuum.io/
.. _`PyPi`: https://pypi.python.org/pypi
.. _`PyWPS`: http://pywps.wald.intevation.org/




Expand Down

0 comments on commit 647f163

Please sign in to comment.