docs: added cfchecker process

bird-house · Feb 10, 2015 · 9f9b58c · 9f9b58c
1 parent 34b4f22
commit 9f9b58c
Show file tree

Hide file tree

Showing 3 changed files with 114 additions and 0 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -20,6 +20,7 @@ Contents:
    installation/index
    configuration/index
    testing/index
+   processes/index
 
 
 

diff --git a/docs/source/processes/index.rst b/docs/source/processes/index.rst
@@ -0,0 +1,50 @@
+.. _processes:
+WPS Processes
+*************
+
+We describe here the WPS processes available in Hummingbird.
+
+CFChecker
+=========
+
+The `cfchecker <https://pypi.python.org/pypi/cfchecker>`_ checks NetCDF files for compliance to the Climate Forcast Conventions (CF) standard.
+
+The process expects one or more NetCDF files which should be checked and an optional parameter for the CF version.
+
+WPS process description
+-----------------------
+
+Using the default Hummingbird installation the ``DescribeProcess`` request is as follows:
+
+http://localhost:8092/wps?service=WPS&version=1.0.0&request=DescribeProcess&identifier=cfchecker
+
+The XML response of the WPS service is the following document:
+
+.. literalinclude:: wps_cfchecker.xml
+    :language: xml
+    :linenos:
+
+The WPS Parameters are:
+
+*resource*
+     Is the input parameter to provide one or more URLs (``http://``, ``file://``) to NetCDF files. 
+     It is a WPS `ComplexData <http://pywps.wald.intevation.org/documentation/course/ogc-wps/index.html#complexdata>`_ type with MIME-type ``application/x-netcdf``.
+
+*cf_version*
+     Is an optional input parameter to provide the CF version to check against. It is a WPS `LiteralData <http://pywps.wald.intevation.org/documentation/course/ogc-wps/index.html#literaldata>`_ type with a set of allowed values (1.1, 1.2, ..., auto).
+
+*output*
+     Is the output parameter to provide the report of the CF check as text document. 
+     It is a WPS ComplexData type with MIME-type ``text/plain``.
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/source/processes/wps_cfchecker.xml b/docs/source/processes/wps_cfchecker.xml
@@ -0,0 +1,63 @@
+<?xml version="1.0" encoding="utf-8"?>
+<wps:ProcessDescriptions xmlns:wps="http://www.opengis.net/wps/1.0.0" xmlns:ows="http://www.opengis.net/ows/1.1" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opengis.net/wps/1.0.0 http://schemas.opengis.net/wps/1.0.0/wpsDescribeProcess_response.xsd" service="WPS" version="1.0.0" xml:lang="en-CA">
+    <ProcessDescription wps:processVersion="0.1" storeSupported="true" statusSupported="true">
+        <ows:Identifier>cfchecker</ows:Identifier>
+        <ows:Title>CF Checker</ows:Title>
+        <ows:Abstract>The cfchecker checks NetCDF files for compliance to the CF standard.</ows:Abstract>
+        <DataInputs>
+            <Input minOccurs="1" maxOccurs="1000">
+                <ows:Identifier>resource</ows:Identifier>
+                <ows:Title>NetCDF File</ows:Title>
+                <ows:Abstract>NetCDF File</ows:Abstract>
+                <ComplexData>
+                    <Default>
+                        <Format>
+                            <MimeType>application/x-netcdf</MimeType>
+                        </Format>
+                    </Default>
+                    <Supported>
+                        <Format>
+                            <MimeType>application/x-netcdf</MimeType>
+                        </Format>
+                    </Supported>
+                </ComplexData>
+            </Input>
+            <Input minOccurs="0" maxOccurs="1">
+                <ows:Identifier>cf_version</ows:Identifier>
+                <ows:Title>CF version</ows:Title>
+                <ows:Abstract>CF version to check against, use auto to auto-detect the file version.</ows:Abstract>
+                <LiteralData>
+                    <ows:DataType ows:reference="http://www.w3.org/TR/xmlschema-2/#string">string</ows:DataType>
+                    <ows:AllowedValues>
+                            <ows:Value>auto</ows:Value>
+                            <ows:Value>1.6</ows:Value>
+                            <ows:Value>1.5</ows:Value>
+                            <ows:Value>1.4</ows:Value>
+                            <ows:Value>1.3</ows:Value>
+                            <ows:Value>1.2</ows:Value>
+                            <ows:Value>1.1</ows:Value>
+                    </ows:AllowedValues>
+                    <DefaultValue>auto</DefaultValue>
+                </LiteralData>
+            </Input>
+        </DataInputs>
+        <ProcessOutputs>
+            <Output>
+                <ows:Identifier>output</ows:Identifier>
+                <ows:Title>CF Checker Report</ows:Title>
+                <ComplexOutput>
+                    <Default>
+                        <Format>
+                            <MimeType>text/plain</MimeType>
+                        </Format>
+                    </Default>
+                    <Supported>
+                        <Format>
+                            <MimeType>text/plain</MimeType>
+                        </Format>
+                    </Supported>
+                </ComplexOutput>
+            </Output>
+        </ProcessOutputs>
+    </ProcessDescription>
+</wps:ProcessDescriptions>