Skip to content

Commit

Permalink
update index, tutorial and notebooks added
Browse files Browse the repository at this point in the history
  • Loading branch information
cehbrecht committed Mar 10, 2015
1 parent f8a93cc commit eb44272
Show file tree
Hide file tree
Showing 7 changed files with 36 additions and 28 deletions.
6 changes: 3 additions & 3 deletions docs/source/appendix.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _appendix:

********
Appendix
********
************
Useful Links
************

WPS Software
============
Expand Down
2 changes: 2 additions & 0 deletions docs/source/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Table of contents:
#. :ref:`getting-help`

.. _general-questions:

General questions
=================

Expand All @@ -18,6 +19,7 @@ General questions
The available packages are used in the climate science community.

.. _getting-help:

Getting help
============

Expand Down
2 changes: 1 addition & 1 deletion docs/source/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ Birdhouse 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>`.
See: `What is WPS? <http://geoprocessing.info/wpsdoc/Concepts#what>`_.
30 changes: 12 additions & 18 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,32 +17,32 @@ Birdhouse is the home of the following WPS components (birds):
* :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
* `Emu <http://emu.readthedocs.org/en/latest/>`_: some example WPS processes
* `Birdy <http://birdy.readthedocs.org/en/latest/>`_: 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: 1

overview
tutorial
anaconda
docker
notebooks
faq
glossary
appendix


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

Development discussion takes place on the `wps mailing list <>`_
News are published to the `wps mailing list <https://lists.dkrz.de/mailman/listinfo/wps>`_

Presentations & Blog Posts
==========================
Expand All @@ -58,12 +58,6 @@ 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
6 changes: 6 additions & 0 deletions docs/source/notebooks.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
IPython Notebooks
=================

* `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>`_

11 changes: 5 additions & 6 deletions docs/source/overview.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
.. _overview:
************
Overview
************

******************
Birdhouse Overview
******************

.. _wps_use_case:
============
Expand All @@ -11,14 +10,14 @@ 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
.. image:: images/wps-use-case.png

.. _birdhouse_overview:
=============================
Birdhouse with WPS components
=============================

.. image:: birdhouse.png
.. image:: images/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.

Expand Down
7 changes: 7 additions & 0 deletions docs/source/tutorial.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Tutorials
=========

* `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/>`_
* `Phoenix Tutorial on ReadTheDocs (outdated) <http://pyramid-phoenix.readthedocs.org/en/latest/tutorial/index.html>`_

0 comments on commit eb44272

Please sign in to comment.