Skip to content

Commit

Permalink
added dev_guide with writing a process
Browse files Browse the repository at this point in the history
  • Loading branch information
cehbrecht committed Mar 16, 2015
1 parent efe202d commit 6eb7240
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 11 deletions.
26 changes: 16 additions & 10 deletions docs/source/dev_guide.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,25 @@
.. _devguide:

***************
Developer Guide
***************
===============

.. contents::
:local:
:depth: 2

Writing a WPS process
---------------------

In Birdhouse we are using the :term:`PyWPS` implementation of a :term:`Web Processing Service`. Writing a WPS process in Birdhouse is the same as in PyWPS. The PyWPS documentation has a `tutorial on writing a process <http://pywps.wald.intevation.org/documentation/course/process/index.html>`_. *Please* follow this PyWPS tutorial.

To get easier started you can install :ref:`Emu <emu:installation>` with some example processes for PyWPS.

*Please* read the documentation of `PyWPS Tutorial`_, `OWSLib WPS`_ and `OGC WPS`_.

To set up PyWPS with example processes you can use the `Emu WPS`_ from Birdhouse.

.. _`OGC WPS`: http://www.opengeospatial.org/standards/wps
.. _`PyWPS`: http://pywps.wald.intevation.org/index.html
.. _`PyWPS Tutorial`: http://pywps.wald.intevation.org/documentation/course/process/index.html
.. _`OWSLib WPS`: http://geopython.github.io/OWSLib/#wps
.. _`Emu WPS`: https://github.com/bird-house/emu/blob/master/README.rst
.. _`Birdhouse`: http://bird-house.github.io/







Expand Down
13 changes: 12 additions & 1 deletion docs/source/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ Glossary
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
https://en.wikipedia.org/wiki/Open_Geospatial_Consortium,
http://www.opengeospatial.org/standards/wps

WPS
Web Processing Service
Expand Down Expand Up @@ -54,3 +55,13 @@ Glossary
Docker
*Docker* - An open platform for distributed applications for developers and sysadmins.
https://www.docker.com/

GeoPython
GitHub organisation of Python projects related to geospatial.
https://geopython.github.io/

OWSLib
OWSLib is a Python package for client programming with :term:`Open Geospatial Consortium` web service interface standards, and their related content models. OWSLib has :term:`WPS` client library which is used in Birdhouse to access WPS services.
http://geopython.github.io/OWSLib/,
http://geopython.github.io/OWSLib/#wps

1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Getting started
overview
installation
tutorial
dev_guide
contributing
faq
glossary
Expand Down

0 comments on commit 6eb7240

Please sign in to comment.