Skip to content

Commit

Permalink
filling with initial docs from birdhouse web page
Browse files Browse the repository at this point in the history
  • Loading branch information
cehbrecht committed Mar 10, 2015
1 parent ce1c74f commit 0c5b8e9
Show file tree
Hide file tree
Showing 2 changed files with 74 additions and 5 deletions.
8 changes: 7 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -265,4 +265,10 @@


# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'http://docs.python.org/': None}
intersphinx_mapping = {'python': ('http://docs.python.org/', None),
'phoenix': ('http://pyramid-phoenix.readthedocs.org/en/latest/', None),
'malleefowl': ('http://malleefowl.readthedocs.org/en/latest/', None),
'flyingpigeon': ('http://flyingpigeon.readthedocs.org/en/latest/', None),
'hummingbird': ('http://birdhouse-hummingbird.readthedocs.org/en/latest/', None),
'emu': ('http://emu.readthedocs.org/en/latest/', None),
'birdy': ('http://birdy.readthedocs.org/en/latest/', None)}
71 changes: 67 additions & 4 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,77 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Birdhouse's documentation!
=====================================
Introduction
============

Contents:
Birdhouse is a collection of OGC Web Processing Service (WPS) related
Python components to support data processing in the climate science
community. The aim of Birdhouse is to make the usage of WPS easy. Most
of the OGC/WPS related software comes from the `GeoPython project <http://geopython.github.io/>`_.

Birdhouse is the home of the following WPS components (birds):

* :ref:`Phoenix <phoenix:installation>`: a web-based WPS client with ESGF data access
* :ref:`Malleefowl <malleefowl:installation>`: access to climate data (ESGF, ...) as a service and library
* :ref:`Flyingpigeon <flyingpigeon:installation>`: services for the climate impact community
* :ref:`Hummingbird <hummingbird:installation>`: provides cdo and cfchecker as a service
* :ref:`Emu <emu:installation>`: some example WPS processes
* :ref:`Birdy <birdy:installation>`: a WPS command line tool

You can find the source code for all Birdhouse components on
`our github page <http://github.com/bird-house>`_.

Getting started
===============

* `Web Processing Service Information Site <http://geoprocessing.info/wpsdoc/index>`_
* `PyWPS Tutorial <http://pywps.wald.intevation.org/documentation/course/process/index.html>`_
* `Emu: starting with some WPS test processes <http://emu.readthedocs.org/en/latest/>`_
* `IPython Notebook tutorial for using WPS on nbviewer.ipython.org <http://nbviewer.ipython.org/github/bird-house/pyramid-phoenix/tree/master/docs/notebook/tutorial/>`_
* `IPython Notebook tutorial for using WPS on GitHub <https://github.com/bird-house/pyramid-phoenix/tree/master/docs/notebook/tutorial>`_
* `Useful WPS links <http://pyramid-phoenix.readthedocs.org/en/latest/appendix/index.html>`_
* `Birdhouse Overview (outdated) <http://pyramid-phoenix.readthedocs.org/en/latest/overview/index.html>`_
* `Phoenix Tutorial on ReadTheDocs (outdated) <http://pyramid-phoenix.readthedocs.org/en/latest/tutorial/index.html>`_

.. toctree::
:maxdepth: 2
:maxdepth: 1

Birdhouse Anaconda Packages
---------------------------

* `Conda Recipes for Birdhouse on GitHub <https://github.com/bird-house/conda-recipes>`_
* `Birdhouse packages on Binstar (pywps, cdo, ocgis, ...) <https://binstar.org/birdhouse>`_

Docker images for Birdhouse
---------------------------

* `Birdhouse docker images on Docker Hub <https://registry.hub.docker.com/repos/birdhouse/>`_
* `Example: running Emu WPS in docker <http://emu.readthedocs.org/en/latest/#example-using-docker>`_

Getting involved
================

Development discussion takes place on the `wps mailing list <>`_

Presentations & Blog Posts
==========================

* Helsinki
* Prag
* CSC 2.0 Hamburg
* Vienna
* LSDMA

License Agreement
=================

Birdhouse components are distributed under the `Apache License, Version 2.0 <http://opensource.org/licenses/Apache-2.0>`_.

Birdhouse FAQ
=============

Glossary
========


Indices and tables
Expand Down

0 comments on commit 0c5b8e9

Please sign in to comment.