update .gitignore ... added faq, glossary, overview, appendix, ...

.gitignore

@@ -1,54 +1,66 @@
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
+# installer
+#Makefile
 
-# C extensions
-*.so
-
-# Distribution / packaging
-.Python
-env/
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-*.egg-info/
-.installed.cfg
-*.egg
+# Docker
+#Dockerfile
 
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
+# custom configs
+custom.cfg
 
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
+# Python / Extensions etc.
+*~
+*.mo
+*.so
+*.pyc
+*.pyo
+*.egg
+*.egg-info
+*.sqlite
+*.bak
 
-# Unit test / coverage reports
-htmlcov/
-.tox/
+# Unit test / Coverage reports
 .coverage
-.cache
+.tox
 nosetests.xml
-coverage.xml
+unit_tests/testdata.json
 
-# Translations
-*.mo
-*.pot
+# Eclipse / PyDev
+.project
+.pydevproject
+.settings
 
-# Django stuff:
-*.log
+# Kate
+*.kate-swp
+
+# Sublime Text Editor
+*.sublime*
+
+# buildout
+bin
+develop-eggs
+eggs
+parts
+build
+dist
+downloads
+.installed.cfg
+.mr.developer.cfg
+bootstrap-buildout.py
+bootstrap.py
+#generated by buildout
 
-# Sphinx documentation
+# sphinx
+#docs/Makefile
+#docs/make.bat
 docs/build/
 
-# PyBuilder
-target/
+
+# ipython
+.ipynb_checkpoints
+
+# External Sources
+#src/external
+
+# tests
+*.log
+*.lock

docs/source/anaconda.rst

@@ -0,0 +1,5 @@
+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>`_

docs/source/appendix.rst

@@ -0,0 +1,122 @@
+.. _appendix:
+
+********
+Appendix
+********
+
+WPS Software
+============
+
+WPS Server Software:
+
+* PyWPS - https://github.com/geopython/PyWPS
+* GeoServer - http://docs.geoserver.org/stable/en/user/extensions/wps/processes.html
+* Zoo - http://www.zoo-project.org
+* COWS - http://ceda-wps2.badc.rl.ac.uk/docs/cows_wps/intro.html
+* Deegree - http://www.deegree.org/
+* 52 North - http://52north.org/communities/geoprocessing/wps/
+
+WPS Client Software:
+
+* OWSLib - http://geopython.github.io/OWSLib/
+* OpenLayers WPS Plugin - http://dev.openlayers.org/docs/files/OpenLayers/WPSClient-js.html
+* GeoTools WPS Module - http://docs.geotools.org/latest/userguide/unsupported/wps.html
+
+Scientific Workflow Tools
+=========================
+
+Workflow Engines:
+
+* RestFlow - https://github.com/restflow-org/restflow/wiki
+* Taverna - http://www.taverna.org.uk/
+* VisTrails - http://www.vistrails.org/index.php/Main_Page
+* Kepler - https://kepler-project.org/
+* KNIME - http://www.knime.org/
+
+Taverna with WPS:
+
+* http://rsg.pml.ac.uk/wps/generic.cgi?request=GetCapabilities&service=WPS
+* http://www.youtube.com/watch?v=JNAtoOejVIo
+* http://www.taverna.org.uk/introduction/services-in-taverna/  
+* https://github.com/myGrid/small-area-estimator
+* http://comments.gmane.org/gmane.science.biology.informatics.taverna.user/1415
+* http://dev.mygrid.org.uk/wiki/display/developer/SCUFL2
+
+VisTrails with WPS:
+
+* http://code.google.com/p/eo4vistrails/
+* http://proj.badc.rl.ac.uk/cows/wiki/CowsWps/CDOWPSWorkingGroup/WPSAndWorkflows  
+* http://www.kitware.com/source/home/post/105
+
+Kepler with WPS:
+
+* https://kepler-project.org/users/sample-workflows
+
+Other Workflow Engines:
+
+* http://www.yawlfoundation.org/
+* http://en.wikipedia.org/wiki/Scientific_workflow_system
+* http://airavata.apache.org/
+* http://search.cpan.org/~nuffin/Class-Workflow-0.11/
+
+Related Projects:
+
+* http://climate4impact.eu/impactportal/general/index.jsp
+* http://adaguc.knmi.nl/
+* http://evolvingweb.github.io/ajax-solr/examples/reuters/index.html
+* http://ceda-wps2.badc.rl.ac.uk/ui/home
+
+
+Scientific Python
+=================
+
+* Anaconda - https://store.continuum.io/cshop/anaconda/
+
+Completely free enterprise-ready Python distribution for large-scale
+data processing, predictive analytics, and scientific computing
+
+* pandas - http://pandas.pydata.org/
+
+Python Data Analysis Library
+
+Python in Climate Science
+========================= 
+
+* OpenClimateGIS - https://earthsystemcog.org/projects/openclimategis/
+
+OpenClimateGIS is a Python package designed for geospatial
+manipulation, subsetting, computation, and translation of climate
+datasets stored in local NetCDF files or files served through THREDDS
+data servers. [..]
+
+* ICCLIM (i see clim ...) - https://github.com/tatarinova/icclim
+
+Python library for climate indices calculation. 
+Documentation at http://icclim.readthedocs.org/
+
+Python Web Frameworks and Utils
+===============================
+
+* Authomatic - http://peterhudec.github.io/authomatic/
+* Bootstrap - http://getbootstrap.com/
+* Bootstrap 2.x - http://getbootstrap.com/2.3.2/index.html
+
+Example WPS Services
+====================
+
+List of available Web Processing Services:
+
+* GeoServer Demo WPS - http://demo.opengeo.org/geoserver/wps?request=GetCapabilities&service=WPS
+* Plymoth Marine Laboratory - http://rsg.pml.ac.uk/wps/generic.cgi?request=GetCapabilities&service=WPS
+* Plymoth Marine Laboratory - http://rsg.pml.ac.uk/wps/vector.cgi?request=GetCapabilities&service=WPS
+* USGS Geo Data Portal- http://cida.usgs.gov/climate/gdp/process/WebProcessingService
+* KNMI climate4impact Portal - http://climate4impact.eu//impactportal/WPS?request=GetCapabilities&service=WPS
+* BADC CEDA - http://ceda-wps2.badc.rl.ac.uk/wps?request=GetCapabilities&service=WPS 
+* delatres - http://dtvirt5.deltares.nl/wps/?Request=GetCapabilities&Service=WPS
+* 52 North - http://geoprocessing.demo.52north.org:8081/wps/WebProcessingService
+
+Using WPS ...
+=============
+
+* PyWPS tutorial - http://wiki.ieee-earth.org/Documents/GEOSS_Tutorials/GEOSS_Provider_Tutorials/Web_Processing_Service_Tutorial_for_GEOSS_Providers
+

docs/source/docker.rst

@@ -0,0 +1,5 @@
+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>`_

docs/source/faq.rst

@@ -0,0 +1,24 @@
+=============
+Birdhouse FAQ
+=============
+
+Table of contents:
+==================
+
+#. :ref:`general-questions`
+#. :ref:`getting-help`
+
+.. _general-questions:
+General questions
+=================
+
+#. What is Birdhouse?
+
+   *Birdhouse* is collection of Python packages to make the usage of Web Processing Services easy.
+   The available packages are used in the climate science community.
+
+.. _getting-help:
+Getting help
+============ 
+
+

docs/source/glossary.rst

@@ -0,0 +1,10 @@
+==================
+Birdhouse Glossary
+==================
+
+.. glossary::
+
+   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>`.

docs/source/index.rst

@@ -38,17 +38,6 @@ Getting started
 .. toctree::
    :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
 ================

docs/source/overview.rst

@@ -0,0 +1,34 @@
+.. _overview:
+************
+Overview
+************
+
+
+.. _wps_use_case:
+============
+WPS Use Case
+============
+
+A user runs a WPS processes remotely on a machine with direct access to climate data archives.
+
+.. image:: wps-use-case.png
+
+.. _birdhouse_overview:
+=============================
+Birdhouse with WPS components
+=============================
+
+.. image:: birdhouse.png
+
+ESGF is currently the main climate data resource (but more resources are possible). ESGF Solr-index is used to find ESGF data. The ESGF identity provider with OpenIDs and X509 certificate is used for authenticatin.
+
+There are several WPS services. Malleefowl is the main one for the Phoenix client. Malleefowl is used to search, download (with caching) ESGF data and to retrieve certificates. Malleefowl has also a workflow engine (dispel4py) to chain WPS processes. 
+
+The results of the WPS processes are stored on the file system and are accessible via URL (with a token id).
+
+Results can be shown on a Map using a Web Mapping Service (ncWMS, adagucserver).
+
+The PyCSW Catalog Service is used to register WPS services and also to publish WPS outputs. Published results in the PyCSW can also used as input source for processes again.
+
+WPS serivces can be accessed through web-applications like Phoenix or from scripts.
+