Index: /branches/prototype-v0/docs/install/installation.rst =================================================================== --- /branches/prototype-v0/docs/install/installation.rst (revision 903) +++ /branches/prototype-v0/docs/install/installation.rst (revision 904) @@ -147,5 +147,23 @@ `_. - +Metadata Database (Optional) +***************************** + +.. _zoo_create_metadb: + +It is possible to use a PostgreSQL database to store metadata +information about WPS Services. This support is optional and require +to be activated by using the ``--with-metadb=yes`` option. + +To create the database for storing the metadata informations about the +WPS Services, you may use the following command: + +.. code:: + + createdb zoo_metadb + psql zoo_metadb -f zoo-project/zoo-kernel/sql/zoo_collectiondb.sql + +In case you want to convert an existing zcfg file then, you can use +the ``zcfg2sql`` tool from the command line. YAML Support (Optional) @@ -154,5 +172,5 @@ If ``yaml.h`` file is not found in your ``/usr/include`` directory and ``libyaml.so`` is not found in ``/usr/lib``, a ``--with-yaml`` option -can be used to specify its location. For instance, if the headeer file +can be used to specify its location. For instance, if the header file lies in ``/usr/local/include`` and the shared library is located in ``/usr/local/lib``, you may use the following command: Index: /branches/prototype-v0/docs/kernel/configuration.rst =================================================================== --- /branches/prototype-v0/docs/kernel/configuration.rst (revision 903) +++ /branches/prototype-v0/docs/kernel/configuration.rst (revision 904) @@ -94,9 +94,18 @@ service providers, e.g., shared libraries with service implementations (the ``serviceProvider`` parameter in the service configuration (.zcfg) file). + * ``memory``: (Optional) can take the value ``load`` to ensure that + the value field of the inputs data will be filled by the ZOO-Kernel + or ``protected`` to have only the ``cache_file`` filled. + .. warning:: The ``libPath`` parameter is currently only recognized by services implemented in C/C++ or PHP, and may be moved to another section in future versions. - + + +.. warning:: + Depending on the ``memory`` parameter the WPS Service will receive + different fields (``value`` or ``cache_file``). + In case you have activated the MapServer support, please refer to :ref:`this specific section `. @@ -264,4 +273,20 @@ hosts=localhost,127.0.0.1 +Optionaly, you can also define the shared url(s), meaning that even if +the ressource requires authentication to be accessed, this +authentifcation won't be used to define the name for storing the +file. Hence, two user with different authentication will use the same +file as it is considerated as shared. You can find bellow a sample +security section containing the shared parameter. In this example, +every requests to access the coverage using the url defined in the +shared parameter (``myHost/cgi-bin/WCS_Server``) will be shared +between users. + +.. code:: + + [security] + attributes=Authorization,Cookie,User-Agent + hosts=localhost,127.0.0.1 + shared=myHost/cgi-bin/WCS_Server .. _zoo_activate_db_backend: @@ -300,4 +325,38 @@ to setup the database. + +Database section +............................... + +The database section allows to configure the ZOO-Kernel to access the +metadata information about WPS Services by using a PostgreSQL database +in addition to the zcfg files. + +.. code-block:: guess + + [metadb] + dbname=zoo_metadb + port=5432 + user=username + host=127.0.0.1 + type=PG + +This will generate strings to be passed to GDAL to connect the +database server: + +.. code-block:: guess + + :host= port= user= dbname= + + +With the previous database section, it will give the following: + +.. code-block:: guess + + PG:"dbname=zoo_metadb host=127.0.0.1 port=5432 user=username" + +Please refer to this `section `_ to learn how +to setup the database. + Include section ............................... Index: /branches/prototype-v0/docs/kernel/index.rst =================================================================== --- /branches/prototype-v0/docs/kernel/index.rst (revision 903) +++ /branches/prototype-v0/docs/kernel/index.rst (revision 904) @@ -14,3 +14,3 @@ orfeotoolbox sagagis - + hpc Index: /branches/prototype-v0/docs/kernel/mapserver.rst =================================================================== --- /branches/prototype-v0/docs/kernel/mapserver.rst (revision 903) +++ /branches/prototype-v0/docs/kernel/mapserver.rst (revision 904) @@ -73,11 +73,11 @@ * `MapServer `__ version >= 6.0.1 -First download the lastest zoo-kernel by checking out the svn. Use the following command from do the directory where your previously checked out (in this example we will use ```` to design this directory). - -.. code-block:: guess - - cd - svn checkout http://svn.zoo-project.org/svn/trunk/zoo-kernel zoo-kernel-ms - +First download the lastest zoo-kernel by checking out the svn. Use the following command from do the directory where your previously checked out (in this example we will use ``$PREV_SVN_CO`` to design this directory). + +.. code-block:: guess + + svn checkout http://svn.zoo-project.org/svn/trunk/ $PREV_SVN_CO + cd $PREV_SVN_CO + Then uncompress the MapServer archive (ie. ``mapserver-6.0.1.tar.bz2``) into ``/tmp/zoo-ms-src``, and compile it using the following command: @@ -92,18 +92,13 @@ cp mapserv /usr/lib/cgi-bin -Once done, compile ZOO-Kernel with MapServer support from the ```` directory, using the following command: - -.. code-block:: guess - - cd zoo-kernel-ms +Once done, compile ZOO-Kernel with MapServer support from the ``$PREV_SVN_CO`` directory, using the following command: + +.. code-block:: guess + + cd zoo-kernel autoconf ./configure --with-python --with-mapserver=/tmp/zoo-ms-src/mapserver-6.0.1 make - -You can then copy the new ZOO-Kernel to ``/usr/lib/cgi-bin`` directory, as follow: - -.. code-block:: guess - - cp zoo_loader.cgi /usr/lib/cgi-bin + sudo make install @@ -119,4 +114,14 @@ dataPath = /var/www/temp/ mapserverAddress=http://localhost/cgi-bin/mapserv + +You can also add the following lines to the ``[main]`` section, in case +you want to use a default style for Polygon, Lines and Points vector +layer. + +.. code-block:: guess + + msStylePoly=STYLE COLOR 202 109 19 OUTLINECOLOR 105 105 105 WIDTH 3 END + msStyleLine=STYLE OUTLINECOLOR 202 109 19 WIDTH 3 END + msStylePoint=STYLE COLOR 202 109 19 OUTLINECOLOR 105 105 105 SYMBOL 0 SIZE 14 END The ``dataPath`` directory is mandatory and must belong to the Apache user. @@ -175,4 +180,10 @@ ************* +You have different options to define the style of the layer created +using the data returned by your service. + +msStyle ++++++++ + The optional ``msStyle`` parameter can also be used to define a custom MapServer style block (used for vector datasource only), as follow: @@ -181,9 +192,88 @@ msStyle = STYLE COLOR 125 0 105 OUTLINECOLOR 0 0 0 WIDTH 3 END -If a WPS service outputs a one band raster file, then it is possible to add a ``msClassify`` parameter and set it to ``true`` in the output ComplexData ```` or ```` nodes of its ``zcfg`` file. This allows ZOO-Kernel to use its own default style definitions in order to classify the raster using equivalent intervals. - -.. code-block:: guess - - msClassify = .... +msClassify +++++++++++ + +If a WPS service outputs a one band raster file, then it is possible +to add a ``msClassify`` parameter and set it to ``true`` in the output +ComplexData ```` or ```` nodes of its zcfg +file. This allows ZOO-Kernel to use its own default style definitions +in order to classify the raster using equivalent intervals. + +.. code-block:: guess + + msClassify = true + + +msInclude ++++++++++ + +In case you want to use another layer which use the result of your +service, for instance to produce a `heatmap +`_, then you can use +the +``msInclude`` and ``msLayer`` options in the output ``ComplexData`` +```` or ```` nodes of its zcfg file. You can see below an +example of use of this two options with the associated mapfile. + +.. code-block:: guess + + msInclude = /var/data/template.map + msLayer = heatmap + +You can find below a sample ``/var/data/template.map``: + +.. code-block:: guess + + MAP + SIZE 1000 500 + EXTENT -180 -90 180 90 + NAME "test heat" + IMAGETYPE "png" + + WEB + METADATA + "ows_srs" "epsg:4326 epsg:3857 epsg:900913" + "ows_enable_request" "*" + END # METADATA + END # WEB + + PROJECTION + "+init=epsg:4326" + END # PROJECTION + + LAYER + NAME "heatmap" # Corresponding to the msLayer defined + TYPE raster + CONNECTIONTYPE kerneldensity + CONNECTION "Result" + STATUS on + PROCESSING "RANGE_COLORSPACE=HSL" + PROCESSING "KERNELDENSITY_RADIUS=20" + PROCESSING "KERNELDENSITY_COMPUTE_BORDERS=ON" + PROCESSING "KERNELDENSITY_NORMALIZATION=AUTO" + OFFSITE 0 0 0 + CLASS + STYLE + COLORRANGE "#0000ff00" "#0000ffff" + DATARANGE 0 32 + END # STYLE + STYLE + COLORRANGE "#0000ffff" "#ff0000ff" + DATARANGE 32 255 + END # STYLE + END # CLASS + END # LAYER + + LAYER + NAME "points" + STATUS on + TYPE POINT + #DATA "/Library/WebServer/cache//ef76ee6642c1ea704e847e28120ba1ca.zca" + END # LAYER + END # MAPFILE + + + Example @@ -216,5 +306,5 @@ useMapserver = true asReference = true - msClassify = .... + msClassify = true Index: /branches/prototype-v0/docs/kernel/sagagis.rst =================================================================== --- /branches/prototype-v0/docs/kernel/sagagis.rst (revision 903) +++ /branches/prototype-v0/docs/kernel/sagagis.rst (revision 904) @@ -4,9 +4,9 @@ ====================== -`SAGA GIS `_ provides a comprehensive set of geoscientific methods and spatial algorithms. The optional SAGA GIS support is available since `ZOO-Project 1.5 `__. It allows to execute the `SAGA Modules `_ directly as ZOO WPS Services thanks to a :ref:`kernel_index` specific internal mechanism which is detailed in this section. +`SAGA GIS `_ provides a comprehensive set of geoscientific methods and spatial algorithms. The optional SAGA GIS support is available since `ZOO-Project 1.5 `__. It allows to execute the `SAGA Modules `_ directly as ZOO WPS Services thanks to a :ref:`kernel_index` specific internal mechanism which is detailed in this section. .. note:: - |saga| `SAGA GIS `__ is the System for Automated Geoscientific Analyses. Learn more on official `website `__. + |saga| `SAGA GIS `__ is the System for Automated Geoscientific Analyses. Learn more on official `website `__. @@ -27,19 +27,10 @@ * latest `ZOO-Kernel `_ trunk version - * SAGA GIS (`SAGA-GIS 2.1.4 `_ ) - * libLAS-1.2 (`LibLAS-1.2 `_ ) + * `SAGA GIS `_ (7.2.0) Installation steps ........................... -.. Note:: These installation steps were successfully tested on Ubuntu 14.4 LTS - -Download lastest ZOO-Kernel code from SVN. - -.. code-block:: guess - - svn checkout http://svn.zoo-project.org/svn/trunk/zoo-kernel zoo-kernel - -Then compile ZOO-Kernel using the needed configuration options as shown bellow: +Compile ZOO-Kernel using the configuration options as shown bellow: .. code-block:: guess @@ -47,9 +38,14 @@ cd zoo-kernel autoconf - ./configure --with-saga=/usr/local/ + ./configure --with-saga=/usr/local/ --with-saga-version=7 make -And copy the newly created zoo_loader.cgi to ``/usr/lib/cgi-bin`` : - +And copy the newly created zoo_loader.cgi to ``/usr/lib/cgi-bin``. + +.. note:: + + The ``--with-saga-version`` option let you set the major + version number of SAGA-GIS. + .. code-block:: guess @@ -62,6 +58,8 @@ **************************** -Building the `saga2zcfg -`_ utility is required to activate the available SAGA-GIS Modules as WPS Services. This can be done using the following command: +Building the +`saga2zcfg `_ +utility is required to activate the available SAGA-GIS Modules as WPS +Services. This can be done using the following command: .. code-block:: guess