Index: branches/PublicaMundi_David-devel/docs/kernel/configuration.rst =================================================================== --- branches/PublicaMundi_David-devel/docs/kernel/configuration.rst (revision 659) +++ branches/PublicaMundi_David-devel/docs/kernel/configuration.rst (revision 659) @@ -0,0 +1,187 @@ +.. _kernel_config: + +ZOO-Kernel configuration +================= + +Main configuration file +----------------------- + +ZOO-Kernel general settings are defined in a configuration file called +``main.cfg``. This file is stored in the same directory as ZOO-Kernel +(``/usr/lib/cgi-bin/`` in most cases). It provides usefull metadata information on your ZOO-Kernel installation. + +.. warning:: + ZOO-Kernel (``/usr/lib/cgi-bin/zoo_loader.cgi``) and its + configuration file (``/usr/lib/cgi-bin/main.cfg``) must be in the + same directory. + +.. note:: + Information contained by ``/usr/lib/cgi-bin/main.cfg`` is accessible from WPS Services at runtime, so when *Execute* requests are used. + +Default main.cfg +............................... + +An example *main.cfg* file is given here as reference. + +.. code-block:: guess + :linenos: + + [headers] + X-Powered-By=ZOO@ZOO-Project + + [main] + version=1.0.0 + encoding=utf-8 + dataPath=/var/data + tmpPath=/var/www/temp + cacheDir=/var/www/cache + sessPath=/tmp + serverAddress=http://localhost/cgi-bin/zoo_loader.cgi + lang=fr-FR,ja-JP + language=en-US + mapserverAddress=http://localhost/cgi-bin/mapserv.cgi + msOgcVersion=1.0.0 + tmpUrl=http:/localhost/temp/ + + [identification] + keywords=t,ZOO-Project, ZOO-Kernel,WPS,GIS + title=ZOO-Project demo instance + abstract= This is ZOO-Project, the Open WPS platform. + accessConstraints=none + fees=None + + [provider] + positionName=Developer + providerName=GeoLabs SARL + addressAdministrativeArea=False + addressDeliveryPoint=1280, avenue des Platanes + addressCountry=fr + phoneVoice=+33467430995 + addressPostalCode=34970 + role=Dev + providerSite=http://geolabs.fr + phoneFacsimile=False + addressElectronicMailAddress=gerald@geolabs.fr + addressCity=Lattes + individualName=Gerald FENOY + + +Main section +............................... + +The main.cfg ``[main]`` section parameters are explained bellow. + + * ``version``: Supported WPS version. + * ``encoding``: Default encoding of WPS Responses. + * ``dataPath``: Path to the directory where data files are stored (used to store mapfiles and data when MapServer support is activated). + * ``tmpPath``: Path to the directory where temporary files are stored (such as *ExecuteResponse* when *storeExecuteResponse* is set to true). + * ``cacheDir``: Path to the directory where cached request files [#f1]_ are stored (optional). + * ``serverAddress``: URL to the ZOO-Kernel instance. + * ``tmpUrl``: URL of the temporary files directory. + * ``mapservAddress``: URL to the MapServer instance (optional). + * ``msOgcVersion``: Version of all supported OGC Web Services output [#f2]_ + (optional). + * ``lang``: Supported natural languages separated by a coma (the first is the default one), + + +Identification and Provider +.......................................... + +The ``[identification]`` and ``[provider]`` sections are not ZOO-Project +specific. They provide OGC metadata [#f3]_ and should be set according +to the `XML Schema Document +`__ which +encodes the parts of ISO 19115 used by the common +*ServiceIdentification* and *ServiceProvider* sections of the +*GetCapabilities* operation response, known as the service metadata +XML document. + +Details of the common OWS 1.1.0 *ServiceIdentification* section can be +found in this `XML Schema Document +`__. + +Details of the common OWS 1.1.0 *ServiceProvider* section can be +found in this `XML Schema Document +`__. + + +Additional sections +-------------------------------- + +Headers section +............................... + +The ``[headers]`` section can be set in order to define a specific HTTP +Response header, which will be used for every response. As an example, +you can check http://zoo-project.org using *curl* command line tool +and notice the specific header *X-Powered-By: Zoo-Project@Trac*. + +env section +............................... + +The ``[env]`` section can be used to store specific environment +variables to be set prior the loading of *Services Provider* and Service execution. + +A typical example is when a Service requires the access to a X server +running on *framebuffer*, which takes to set the DISPLAY environnement +variable, as follow: + +.. code-block:: guess + :linenos: + + [env] + DISPLAY=:1 + +lenv section +............................... + +The ``lenv`` can be used to store runtime informations automatically +set by ZOO-Kernel before and during the execution of a WPS service, +with the following parameters: + + * ``sid`` (r): The WPS Service unique identifier, + * ``status`` (rw): The current progress value ( a value between 0 and + 100 in percent (**%**) ), + * ``cwd`` (r): The current working directory of ZOO-Kernel, + * ``message`` (rw): An error message used when ``SERVICE_FAILED`` is returned (optional), + * ``cookie`` (rw): The cookie to be returned to the client (for + example for authentication purpose). + +senv section +............................... + +The ``senv`` section can be used to store sessions information on the +server side. Such information can then be accessed automatically from +the Service if the server is requested using a valid cookie (as +defined in ``lenv`` section). ZOO-Kernel will store the values set in the +``senv`` maps on disk, load it and dynamically replace its content to +the one in the ``main.cfg``. The ``senv`` section must contain the +following parameter at least: + + * ``XXX``: The session unique identifier where ``XXX`` is the name + included in the cookie which is returned. + +.. _cookie_example: + +For instance, adding the following in the Service source code : + +.. code-block:: python + + conf["lenv"]["cookie"]="XXX=XXX1000000; path=/" + conf["senv"]={"XXX": "XXX1000000","login": "demoUser"} + +means that ZOO-Kernel will create a file named ``sess_XXX1000000.cfg`` +in the ``cacheDir`` directory, and will return the specified cookie to the client. Each time the client will +request ZOO-Kernel using this cookie, it will automatically load the +value stored before the Service execution. + + +.. rubric:: Footnotes + +.. [#f1] If GET requests are passed through ``xlink:href`` to + the ZOO-Kernel , the latter will execute the request the first time and store the result on disk. The next time the same request is executed, the cached file will be used and this will make your process run much faster. If ``cachedir`` was not specified in the ``main.cfg`` then the ``tmpPath`` value will be used. +.. [#f2] Usefull when the :ref:`kernel-mapserver` is activated (available since ZOO-Project version 1.3.0). +.. [#f3] ZOO-Kernel and MapServer are sharing the same metadata for + OGC Web Services if the :ref:`kernel-mapserver` is activated. + + Index: branches/PublicaMundi_David-devel/docs/kernel/index.rst =================================================================== --- branches/PublicaMundi_David-devel/docs/kernel/index.rst (revision 659) +++ branches/PublicaMundi_David-devel/docs/kernel/index.rst (revision 659) @@ -0,0 +1,16 @@ +.. _kernel_index: + +ZOO-Kernel +======== + +This section provides information on **ZOO-Kernel** , the `ZOO-Project `__ WPS server. It will help you to configure and compile ZOO-Kernel. + +.. toctree:: + :maxdepth: 2 + + what + configuration + mapserver + orfeotoolbox + sagagis + Index: branches/PublicaMundi_David-devel/docs/kernel/index.txt =================================================================== --- branches/PublicaMundi_David-devel/docs/kernel/index.txt (revision 506) +++ (revision ) @@ -1,14 +1,0 @@ -.. _kernel: - -ZOO Kernel Documentation -======================== - -The following sections will assist you with the ZOO Kernel: - -.. toctree:: - :maxdepth: 2 - - introduction - installation - mapserver - Index: branches/PublicaMundi_David-devel/docs/kernel/install-centos.txt =================================================================== --- branches/PublicaMundi_David-devel/docs/kernel/install-centos.txt (revision 506) +++ (revision ) @@ -1,168 +1,0 @@ -.. _kernel-installation-centos: - -CentOS -====== - -:Authors: Nicolas Bozon, Gérald Fenoy, Jeff McKenna -:Last Updated: $Date$ - -.. contents:: Table of Contents - :depth: 2 - :backlinks: top - -.. note:: - This documentation was created thanks to Guillaume Sueur from Neogeo Technologies which took time to test - installing the ZOO-Kernel on a CentOS 5.5 environment. - -Requirements ------------- - -Install some standard tools to be able to run ZOO-Kernel on your platform : - -:: - - yum install apache2 - yum install build-essentials - yum install gcc-c++ - yum install zlib-devel - yum install libxml2-devel - yum install bison - yum install openssl - yum install python-devel - yum install subversion - -Compile then install FastCGI library from source - -:: - - wget http://www.fastcgi.com/dist/fcgi.tar.gz - tar xzf fcgi-2.4.0.tar.gz - ./configure - make - make install - echo /usr/local/lib >> /etc/ld.so.conf.d/local.conf - ldconfig - -Compile then install the autoconf tools : - -:: - - wget http://ftp.gnu.org/gnu/autoconf/autoconf-latest.tar.gz - tar xzf autoconf-latest.tar.gz - ./configure --prefix=/usr - make - make install - -Compile then install the flex tool : - -:: - - wget http://downloads.sourceforge.net/project/flex/flex/flex-2.5.35/flex-2.5.35.tar.gz?r=http%3A%2F%2Fflex.sourceforge.net%2F&ts=1292529005&use_mirror=switch - tar xzf flex-2.5.35.tar.gz - cd flex-2.5.35 - ./configure --prefix=/usr - make - make install - -Using the curl provided in the CentOS distribution will produce a ZOO-Kernel unable to run any -Service. Indeed, some segmentation faults occur when trying to run ``Execute`` requests on the ZOO-Kernel, -compiling the ZOO-Kernel setting ``USE_GDB`` flag in the ``CFLAGS`` of your ``Makefile`` will let you run -ZOO-Kernel from gdb and be able to get more information on what is going wrong with your ZOO-Kernel. -Doing this we can figure out that code on `line 173 `__ -and `line 175 `__ have to be commented in the -``ulinet.c`` file to get a ZOO-Kernel working using the curl available in CentOS (curl version 7.15.5). -If you don't apply the modification, you will get an error from a gdb session pointing -segfault in ``Curl_cookie_clearall``. - -You can optionally compile then install curl from source : - -:: - - wget http://curl.haxx.se/download/curl-7.21.3.tar.bz2 - tar xjf curl-7.21.3.tar.bz2 - cd curl-7.21.3 - ./configure --prefix=/usr - make - make install - -Compile then install Python : - -:: - - wget http://www.python.org/ftp/python/2.6.6/Python-2.6.6.tar.bz2 - tar xjf Python-2.6.6.tar.bz2 - cd Python-2.6.6 - ./configure - make - make install - -Compile then install your own GDAL library : - -:: - - wget http://download.osgeo.org/gdal/gdal-1.7.3.tar.gz - tar xzf gdal-1.7.3.tar.gz - cd gdal-1.7.3 - ./configure # add your options here - make - make install - -Install the Sun JAVA SDK into ``/usr/share`` then use the following command to ensure that the ``libjvm.so`` -will be found at runtime from any context. - -:: - - echo /usr/share/java-1.6.0-openjdk-1.6.0.0/jre/lib/i386/client/ >> /etc/ld.so.conf.d/jvm.conf - ldconfig - -Compile ZOO-Kernel and ZOO-Services ------------------------------------ - -Compile then install ZOO-Kernel and your first ZOO-Services. - -First of all, compile the cgic library providen in the SVN source tree: - -:: - - svn co http://svn.zoo-project.org/svn/trunk zoo-project - cd zoo-project/thirds/cgic206 - make - -Compile then install ZOO-Kernel. - -:: - - cd ../../zoo-kernel - ./configure --with-java=/usr/share/jdk1.6.0_23/ --with-python - make zoo_loader.cgi - cp main.cfg /var/www/cgi-bin/ - cp zoo_loader.cgi /var/www/cgi-bin/ - -Compile then deploy your first ZOO-ServicesProviders (simple HelloPy, line 1 and 2, and the OGR base-vect-ops -ServiceProvider, line 3 to 6): - -:: - - cp ../zoo-services/hello-py/cgi-env/*.zcfg /var/www/cgi-bin/ - cp ../zoo-services/hello-py/test_service.py /var/www/cgi-bin/ - cd ../ogr/base-vect-ops/ - make - cp ./cgi-env/* /var/www/cgi-bin/ - vi /var/www/cgi-bin/main.cfg --> set your own informations here - -To ensure that the ``libjvm.so`` will be found from apache, please restart it : - -:: - - /etc/init.d/httpd restart - -Testing your ZOO-Kernel ------------------------ - -Test your ZOO-Kernel from command line: - -:: - - cd /var/www/cgi-bin - ./zoo_loader.cgi "request=Execute&service=WPS&version=1.0.0&Identifier=HelloPy&DataInputs=a=Djay" - ./zoo_loader.cgi "request=Execute&service=WPS&version=1.0.0&Identifier=Buffer&DataInputs=BufferDistance=1@datat Index: branches/PublicaMundi_David-devel/docs/kernel/install-debian.txt =================================================================== --- branches/PublicaMundi_David-devel/docs/kernel/install-debian.txt (revision 506) +++ (revision ) @@ -1,253 +1,0 @@ -.. _kernel-installation-debian: - -Debian / Ubuntu -=============== - -:Authors: Nicolas Bozon, Gérald Fenoy, Jeff McKenna, Luca Delucchi -:Last Updated: $Date$ - -.. contents:: Table of Contents - :depth: 2 - :backlinks: top - -.. note:: - An Ubuntu 10.4 with ZOO virtual image is available at http://www.zoo-project.org/Ubuntu10.4_ZOO.zip - (root: ZOO.test) - -Ubuntu 12.04 dependencies --------------------------------------- - -- install default dependencies - -:: - - sudo apt-get install flex bison libfcgi-dev libxml2 libxml2-dev curl openssl autoconf apache2 python-software-properties subversion libmozjs185-dev python-dev build-essential - -- add ubuntugis repository to obtain the newer GIS libraries - -:: - - sudo add-apt-repository ppa:ubuntugis/ppa - sudo apt-get update - - -- install geographic library - -:: - - sudo apt-get install libgdal1-dev - -- download ZOO source - -Debian 7.0 dependencies --------------------------------------- - -- install dependencies - -:: - - apt-get install flex bison libfcgi-dev libxml2 libxml2-dev curl openssl autoconf apache2 python-software-properties subversion python-dev libgdal1-dev build-essential libmozjs185-dev - - -Installation Workflow --------------------------------------- - -.. note :: In the following lines you will find ``as administrator user`` note, - on Ubuntu you have to add ``sudo`` at the beginning of line, on Debian - you can use ``su -c COMMAND``) - -:: - - svn checkout http://svn.zoo-project.org/svn/trunk zoo-project - -- install cgic from packages - -:: - - cd zoo-project/thirds/cgic206/ - -- compile - -:: - - make - -- if you want use Mapserver (optional) for WMS, WFS and WCS output read :ref:`mapserver` - -- go to kernel path - -:: - - cd ../../zoo-project/zoo-kernel/ - -- create configure file - -:: - - autoconf - -- run configure - -:: - - ./configure --with-js --with-python - -.. note:: For PHP, you must make sure to compile PHP with `--enable-embed `__. - -.. note:: To use MapServer add the option ``--with-mapserver=/path/to/mapserver/source`` - -- compile - -:: - - make - -- copy necessary files into your cgi-bin (as administrator user) - - -:: - - cp main.cfg /usr/lib/cgi-bin - cp zoo_loader.cgi /usr/lib/cgi-bin - -- install ZOO ServiceProvider, in this case we try Python service (as administrator user) - -:: - - cp ../zoo-services/hello-py/cgi-env/*.zcfg /usr/lib/cgi-bin - cp ../zoo-services/hello-py/*.py /usr/lib/cgi-bin/ - -- change some information in the main.cfg (as administrator user) - -:: - - nano /usr/lib/cgi-bin/main.cfg - - serverAddress = http://127.0.0.1 - - -- try the installation - - - http://127.0.0.1/cgi-bin/zoo_loader.cgi?ServiceProvider=&metapath=&Service=WPS&Request=GetCapabilities&Version=1.0.0 - - http://127.0.0.1/cgi-bin/zoo_loader.cgi?ServiceProvider=&metapath=&Service=WPS&Request=DescribeProcess&Version=1.0.0&Identifier=HelloPy - - http://127.0.0.1/cgi-bin/zoo_loader.cgi?ServiceProvider=&metapath=&Service=WPS&Request=Execute&Version=1.0.0&Identifier=HelloPy&DataInputs=a=myname - -.. note:: - If you have some problem in the execute request using Python service, add the following to ``main.cfg``: - - :: - - [env] - PYTHONPATH= - - -Rewrite rule configuration ------------------------------ - -- for better readability and fully functional ZOO Kernel, you have to modify the default - Apache configuration in order to be able to use the http://localhost/zoo/ url directly. - Run (as administrator user) - -:: - - nano /usr/lib/cgi-bin/main.cfg - - serverAddress = http://localhost/zoo - -- first, please create a ``zoo`` directory in ``/var/www/`` which is used by Apache as the - DocumentRoot (as administrator user) - -:: - - mkdir /var/www/zoo - -- Then, please edit the ``/etc/apache2/sites-available/default`` configuration file and add the following - lines after the Directory block related to /var/www directory (as administrator user) - -:: - - - Options Indexes FollowSymLinks MultiViews - AllowOverride All - Order allow,deny - allow from all - - -- now create a small .htaccess file in the ``/var/www/zoo`` containing the following lines (as administrator user) - -:: - - RewriteEngine on - RewriteRule call/(.*)/(.*) /cgi-bin/zoo_loader.cgi?request=Execute&service=WPS&version=1.0.0&Identifier=$1&DataInputs=sid=$2&RawDataOutput=Result [L,QSA] - RewriteRule (.*)/(.*) /cgi-bin/zoo_loader.cgi?metapath=$1 [L,QSA] - RewriteRule (.*) /cgi-bin/zoo_loader.cgi [L,QSA] - - -- for this last file to be taken into account by Apache, you must activate the - rewrite Apache module by copying a load file as bellow (as administrator user) - -:: - - cp /etc/apache2/mods-available/rewrite.load /etc/apache2/mods-enabled/ - -- or using the a2enmod tool this way (as administrator user) - -:: - - a2enmod rewrite - -- now you should be able to access the ZOO Kernel using a simplified by restarting - your Apache Web server (as administrator user) - -:: - /etc/init.d/apache2 restart - -- now you can try: - - - http://localhost/zoo/?Service=WPS&Request=GetCapabilities&Version=1.0.0 - - http://localhost/zoo/?Service=WPS&Request=DescribeProcess&Version=1.0.0&Identifier=HelloPy - - http://localhost/zoo/?Service=WPS&Request=Execute&Version=1.0.0&Identifier=HelloPy&DataInputs=a=myname - -.. _mapserver: - -Compile MapServer ------------------- - -- install MapServer dependencies (as administrator user) - -:: - - apt-get install git libfreetype6-dev libproj-dev libkml-dev libcairo-dev libxml2-dev libgd2-xpm-dev libxslt1-dev - -- extract MapServer from git repository - -:: - - git clone https://github.com/mapserver/mapserver.git - cd mapserver - git checkout branch-6-2 - git pull - -- now compile MapServer - -:: - - ./configure --with-ogr --with-gdal --with-wfsclient --with-wmsclient --with-tiff --with-jpeg --with-gd --with-wcs --with-sos --with-xml2-config --with-wfs --with-fastcgi --with-proj --with-cairo --with-kml=yes --with-xslt --with-threads --with-geos - make - -- now install MapServer (as administrator user) - -:: - - make install - -- now add path to libraries path (as administrator user) - -:: - - nano /etc/ld.so.conf.d/mapserver.conf - - /usr/local/lib/ - -- run as administrator - -:: - - ldconfig Index: branches/PublicaMundi_David-devel/docs/kernel/install-mac.txt =================================================================== --- branches/PublicaMundi_David-devel/docs/kernel/install-mac.txt (revision 506) +++ (revision ) @@ -1,191 +1,0 @@ -.. _kernel-installation-mac: - -Mac OS X -======== - -:Authors: Nicolas Bozon, Gérald Fenoy, Jeff McKenna -:Last Updated: $Date$ - -.. contents:: Table of Contents - :depth: 2 - :backlinks: top - -Using the Installer -------------------- - -1. To install a default build of the ZOO-Project on your Mac OS X computer use the `installer `__. - - .. note:: - The installer assumes that you are using the distributed Apache2 version that comes with your Mac. The installer will - place ZOO-Kernel and ZOO-Services into your cgi-bin at ``/Library/WebServer/CGI-Executables``, and the zoo-demo folder - will be placed within your document root at ``/Library/WebServer/Documents`` - -2. Make sure that your Apache server is running, and then access the ZOO Project Demo at: - - http://localhost/zoo-demo/spatialtools.html - -3. To add additional services, please follow the following intructions to compile your own ZOO Project instance. - -Compiling from Source ---------------------- - -1. Install `Xcode `__. - -2. Before you start downloading the ZOO-Project source code, you'll need to install some tools required to - compile ZOO-Kernel properly. - - First of all install PROJ, GEOS and GDAL frameworks from `here `__. - - At this step, you should get the following directories on your local hard drive : - - :: - - /Library/Frameworks/PROJ.framework - /Library/Frameworks/GEOS.framework - /Library/Frameworks/GDAL.framework - -3. Then, create a ``src`` directory and inside that directory download the `gettext source code `__ and uncompress it. - - now, compile gettext with the following commands to produce a universal binary : - - :: - - cd gettext-0.18.1.1 - CFLAGS="-O -g -arch i386 -arch ppc -arch x86_64" \ - LDFLAGS="-arch i386 -arch ppc -arch x86_64" ./configure - make - sudo make install - -4. Compile and install your ZOO-Kernel - - - Download source from SVN, and use the following command to compile libcgic : - - :: - - svn co http://svn.zoo-project.org/svn/trunk zoo - cd zoo/thirds/cgic206 - make - - - If you produced the ``libcgic.a`` file, you can run ``autoconf`` and then ``configure`` from zoo-kernel directory. - - :: - - cd zoo/zoo-kernel - autoconf - ./configure --with-python --with-java=macos \ - --with-gdal-config=/Library/Frameworks/GDAL.framework/Versions/1.8/Programs/gdal-config - - Obviously, if you don't need Python or Java support then you should remove the corresponding configure option. - - .. note:: - Note that we used the --with-java=macos configure option. Due to the generic location of the JDK on all - Mac OS X platforms, you don't have to provide its full path. - - - Now, run the following commands to compile and deploy your ZOO-Kernel on your Apache server : - - :: - - make - cp zoo_loader.cgi main.cfg /Library/WebServer/CGI-Executables - - You should be ready to request your ZOO-Kernel installation using the following link : http://localhost/cgi-bin/zoo_loader.cgi?request=GetCapabilities&service=WPS . - - If everything is ok, you can follow the next steps to deploy new Services Providers. - - .. note:: - If you are using your own libs (not the default libs on your system) then you must take care to create - universal versions of those libs, as the ZOO-Kernel will try to create a universal binary. If you are - not following this advice, you might receive compile errors of ``symbol(s) not found for architecture ppc`` or ``file was built for - unsupported file format which is not the architecture being linked (ppc)``. - -Deploy the OGR Services Provider --------------------------------- - -Requirements -************ - -Before your try to use any service, please set the correct path in the ``main.cfg`` for tmpPath and tmpUrl. - -You can use the following setup : - -:: - - tmpPath = /Library/WebServer/Documents/tmp - tmpUrl = ../../tmp - -Obviously you'll then need to create this directory, using the following command : - -:: - - mkdir /Library/WebServer/Documents/tmp - -C Version -********* - -To compile the base-vect-ops ServicesProvider you'll need to edit the Makefile in *zoo/zoo-services/ogr/base-vect-ops/* -directory. Add "-I/Library//Frameworks/GEOS.framework/Versions/3/Headers/" to the CFLAGS value on the first line. -To compile, add GDAL framework to the PATH environmenet variable, to ensure that gdal-config tool will be found, -run make and then copy cgi-env files in the /Library/WebServer/CGI-Executables directory. - -:: - - cd zoo/zoo-services/ogr/base-vect-ops/ - export PATH=$PATH:/Library/Frameworks/GDAL.framework/Versions/1.7/Programs/ - make - cp cgi-env/* /Library/WebServer/CGI-Executables - -You can test using this `url `__ -if everything is ok with your setup. - -Python Version -************** - -**Requirements** - -First of all run python from a Terminal.app and try the following import from the python interpreter : - -:: - - import osgeo.ogr - import libxml2 - -If you get an issue when importing the libxml2 module from your python interpreter then that means you -need to install the Python support for the libxml2 library which is already installed on your Mac OS X environment. -To accomplish this, you have first to determine what version of libxml2 is installed on your platform, using the following command: - -xml2-config --version - -Download the source corresponding to your version (i.e. on 10.6.6 you get 2.7.3) from the libxml2 -`download page `__ into your ``src`` directory then uncompress it. - -Use the following command to install the python support : - -:: - - cd src/libxml2-2.7.3/python/ - python setup.py install - -**Deploy OGR Python Services Provider** - -- Now copy the ``zoo-services/ogt/base-vect-ops/cgi-env`` files into ``/Library/WebServer/CGI-Executables``. - -You can test using this `url `__ -if everything is ok with your setup. - -Test using Local Demo Page --------------------------- - -- Download the `OpenLayers `__ library and uncompress it in your personal Sites directory - (located in your home directory). - -- Rename the OpenLayers directory as openlayers. - -- Download this `zip archive `__ - and then uncompress it in your personal Sites directory. - -- Load your local demo pages using urls similar to the following (replacing MyUserName by your MacOS user name) : - - * http://localhost/~MyUserName/zoo-demo/spatialtools.html - * http://localhost/~MyUserName/zoo-demo/spatialtools-py.html - - Index: branches/PublicaMundi_David-devel/docs/kernel/install-opensuse.txt =================================================================== --- branches/PublicaMundi_David-devel/docs/kernel/install-opensuse.txt (revision 506) +++ (revision ) @@ -1,67 +1,0 @@ -.. _kernel-installation-opensuse: - -OpenSUSE -======== - -:Authors: Nicolas Bozon, Gérald Fenoy, Jeff McKenna -:Last Updated: $Date$ - -.. contents:: Table of Contents - :depth: 2 - :backlinks: top - -Zoo-Kernel is maintained as a package in `OpenSUSE Build Service (OBS) `__. -This way, rpm's are provided for all versions of openSUSE Linux (11.2, 11.3, 11.4, Factory). - -Stable Releases ---------------- - -For installing Zoo-Kernel in openSUSE there are 3 ways available: - -One Click Installer -******************* - -One-click installer that can be found `here `__. -For openSUSE 11.4 this is the direct `link `__. - -Yast Software Manager using a GUI -********************************* - -The `Application:Geo `__ repository has to be added -to the Software Repositories and then Zoo-kernel can be found in Software Management through search. - -Command line (as root for openSUSE 11.4) -**************************************** - -:: - - zypper ar http://download.opensuse.org/repositories/Application:/Geo/openSUSE_11.4/ - zypper refresh - zypper install zoo-kernel - -Unstable Version ----------------- - -The latest development version of ZOO-Kernel can be found in OBS under the project `home:tzotsos `__. -ZOO-Kernel packages are maintained and tested there before being released to the Application:Geo repository. - -Installation methods are identical as the stable version. Make sure to use `this `__ repository instead. - -Command line installation (as root for openSUSE 11.4) -***************************************************** - -:: - - zypper ar http://download.opensuse.org/repositories/home:/tzotsos/openSUSE_11.4/ - zypper refresh - zypper install zoo-kernel - zypper install zoo-kernel-grass-bridge - -Additionally, there is the option of adding the zoo-wps-grass-bridge package. This option will automatically install grass7 (svn trunk). - -Try the Installation --------------------- - -- http://localhost/cgi-bin/zoo_loader.cgi?ServiceProvider=&metapath=&Service=WPS&Request=GetCapabilities&Version=1.0.0 -- http://localhost/cgi-bin/zoo_loader.cgi?ServiceProvider=&metapath=&Service=WPS&Request=DescribeProcess&Version=1.0.0&Identifier=HelloPy -- http://localhost/cgi-bin/zoo_loader.cgi?ServiceProvider=&metapath=&Service=WPS&Request=Execute&Version=1.0.0&Identifier=HelloPy&DataInputs=a=myname Index: branches/PublicaMundi_David-devel/docs/kernel/install-prerequisites.txt =================================================================== --- branches/PublicaMundi_David-devel/docs/kernel/install-prerequisites.txt (revision 506) +++ (revision ) @@ -1,76 +1,0 @@ -.. _kernel-installation-prereq: - -Prerequisites -============= - -:Authors: Nicolas Bozon, Gérald Fenoy, Jeff McKenna, Luca Delucchi -:Last Updated: $Date$ - -.. contents:: Table of Contents - :depth: 2 - :backlinks: top - -Obtaining the ZOO Kernel Source -------------------------------- - -.. _svn: - -Use the following command to get the ZOO Kernel source code through Subversion: - -:: - - svn checkout http://svn.zoo-project.org/svn/trunk zoo-project - -For users which get a developer account, use the following: - -:: - - sed "s:\[tunnels\]:\[tunnels\]\nzoosvn = /usr/bin/ssh -p 1046:g" -i ~/.subversion/config - svn co svn+zoosvn://svn.zoo-project.org/var/svn/repos/trunk zoo-project - -The first line of the instruction above defines a specific tunnel to access the svn server through -the SSH protocol. Indeed, the ZOO SVN server listens on the 1046 (1024+22) port rather than the default one (22). - -Prerequisites -------------- - -The following libraries are required on your system before you can install the ZOO Kernel: - -- autoconf ( http://www.gnu.org/software/autoconf/ ) -- cgic ( http://www.boutell.com/cgic ) -- cURL ( http://curl.haxx.se ) -- FastCGI ( http://www.fastcgi.com ) -- Flex & Bison ( http://flex.sourceforge.net/ http://www.gnu.org/software/bison/ ) -- libxml2 ( http://xmlsoft.org ) -- OpenSSL ( http://www.openssl.org ) -- Python ( http://www.python.org ) - -Optional libraries include: - -- MapServer (optional for WMS, WFS and WCS output) ( http://mapserver.org ) -- PHP Embedded (optional) ( http://www.php.net ) -- Java SDK (optional) ( http://java.sun.com ) -- SpiderMonkey (optional) ( http://www.mozilla.org/js/spidermonkey/ ) - -Compile libcgic ---------------- - -The first step is to compile libcgic from the ``zoo-project/thirds`` directory. For such a task, please use -the following command: - -:: - - cd thirds/cgic206 - make - -Make sure that a ``libcgic.a`` is created in your ``zoo-project/thirds/cgic206`` directory. If yes, then -you can go to the next step. - -On Windows, rather than using the make command, please use: - -:: - - nmake /f makefile.vc. - -.. warning:: - If you don't compile libcgic first, and try to compile the ZOO Kernel, you will get an error such as *cannot find -lcgic* Index: branches/PublicaMundi_David-devel/docs/kernel/install-unix.txt =================================================================== --- branches/PublicaMundi_David-devel/docs/kernel/install-unix.txt (revision 506) +++ (revision ) @@ -1,233 +1,0 @@ -.. _kernel-installation-unix: - -Unix -==== - -:Authors: Nicolas Bozon, Gérald Fenoy, Jeff McKenna, Luca Delucchi -:Last Updated: $Date$ - -.. contents:: Table of Contents - :depth: 2 - :backlinks: top - -.. note:: - You must be sure to perform the :ref:`prerequisite steps ` before following this page. - -For the impatient ------------------ - -To build the ``zoo_loader.cgi`` CGI program with the default options, cd to the directory -where you extracted the ZOO Kernel source code package and use the following commands: - -:: - - $ cd zoo-kernel - $ autoconf - $ ./configure - $ make - -Unless something went wrong, you should have executables in the current directory for the ``zoo_loader.cgi`` -CGI program. You can copy the ``zoo_loader.cgi`` program and the ``main.cfg`` file to your HTTP server's CGI -directory and start using it. - -At this step your ZOO-Kernel should work. Nevertheless, don't forget to correct the main.cfg settings -to set ``tmpPath`` and ``tmpUrl`` to fit your web server configuration. - -Configure Options ------------------ - -Here is the list of available options as returned by *./configure --help*: - -:: - - --with-PACKAGE[=ARG] use PACKAGE [ARG=yes] - --without-PACKAGE do not use PACKAGE (same as --with-PACKAGE=no) - --with-gdal-config=FILE specify an alternative gdal-config file - --with-xml2config=FILE specify an alternative xml2-config file - --with-mapserver=PATH specify the path for MapServer compiled source tree - --with-python=PATH To enable python support or specify an alternative - directory for python installation, disabled by - default - --with-pyvers=NUM To use a specific python version - --with-php=PATH To enable php support or specify an alternative - directory for php installation, disabled by default - --with-perl=PATH To enable perl support or specify an alternative - directory for perl installation, disabled by default - --with-java=PATH To enable java support, specify a JDK_HOME, - disabled by default - --with-js=PATH specify --with-js=path-to-js to enable js support, - specify --with-js on linux debian like, js support - is disabled by default - -All the options are described in more details below. - -(Required) GDAL Support -*********************** - -If your gdal-config program is not found in your PATH then you can use the -``--with-gdal-config`` option to specify its location. For instance, let's suppose that your gdal-config -was installed in /usr/local/bin and this directory is not in your PATH, then you can use -the following command: - -:: - - $ ./configure --with-gdal-config=/usr/local/bin/gdal-config - -(Required) XML2 Support -*********************** - -If your xml2-config program is not found in your PATH then you can use the -``--with-xml2config`` option to specify its location. For instance, let's suppose that -your xml2-config was installed in /usr/local/bin and this directory is not in your PATH, -then you can use the following command: - -:: - - $ ./configure --with-xml2config=/usr/local/bin/xml2-config - -(Optional) MapServer Support -***************************** - -If you want to activate the WMS, WFS and WCS outputs using MapServer then you will have -to use the ``--with-mapserver`` option. You have to set the path to your ``mapserver-config`` -locate in the source code of MapServer as following command: - -:: - - $ ./configure --with-mapserver=/path/to/your/mapserver_config/ - -(Optional) Python Support -************************* - -If you want to activate Python support for the ZOO Kernel then you will have to use the -``--with-python`` option. If your python-config program is found in your PATH then you -don't have to specify the path where Python was installed, such as: - -:: - - $ ./configure --with-python - -This assumes that python-config is found in your PATH. - -In the case that your python-config is not found in your PATH, then you can specify the Python -installation directory you are using. For instance, let's suppose that you installed -Python in /usr/local, then you can use the following command: - -:: - - $ ./configure --with-python=/usr/local - -This assumes that /usr/local/bin/python-config exists. - -(Optional) Python Version -************************* - -If you want use a specific version of Python you will have to use the ``--with-pyvers`` -option. You can specify a Python version as: - -:: - - $ ./configure --with-pyvers=2.6 - - -(Optional) PHP Support -********************** - -To be able to activate PHP support for the ZOO Kernel you'll need to get a local PHP Embedded -installation; for more information about the required configure options when compiling PHP you -can refer to this page : - - http://zoo-project.org/trac/wiki/ZooKernel/Embed/PHP - -If you want to activate the PHP support for the ZOO Kernel then you will have to use the -``--with-php`` option. If your php-config program is found in your PATH then you don't have -to specify the path where PHP was installed, then you can use the following commnd: - -:: - - $ ./configure --with-php - -This assumes that php-config is found in your PATH. - -In the case that your php-config is not found in your PATH, then you can specify the PHP installation -directory you are using. For instance, let's suppose that you installed PHP in /usr/local, -then you can use the following command: - -:: - - $ ./configure --with-php=/usr/local - -This assumes that /usr/local/bin/php-config exists. - -(Optional) Perl Support -*********************** - -If you want to activate Perl support for the ZOO Kernel then you will have to use the -``--with-perl`` option. If you do not set any value to this option, then the perl program will -be searched in your PATH. So in such a case, you can use the following command: - -:: - - $ ./configure --with-perl - -This assumes that perl is found in your PATH. - -In the other case, for custom Perl installations, you can set the installation directory. For instance, -let's suppose that you installed Perl in /usr/local and /usr/local/bin is not in your PATH, -then you can use the following command: - -:: - - $ ./configure --with-perl=/usr/local - -This assumes that /usr/local/bin/perl exists. - -(Optional) Java Support -*********************** - -If you want to activate Java support for the ZOO Kernel then you will have to use the -``--with-java`` option and set the installation path of your Java SDK. For instance, -let's suppose that your Java SDK was installed in the /usr/lib/jvm/java-6-sun-1.6.0.22/ directory, -then you can use the following command: - -:: - - $ ./configure --with-java=/usr/lib/jvm/java-6-sun-1.6.0.22/ - -This assumes that the include/linux and jre/lib/i386/client/ subdirectories exist in -/usr/lib/jvm/java-6-sun-1.6.0.22/, include/linux contains the jni.h headers file and -jre/lib/i386/client/ contains the libjvm.so file. - -.. note:: - With Mac OS X you only have to set ``macos`` as the value for the ``--with-java`` option - to activate Java support. For example: - - :: - - $ ./configure --with-java=macos - -(Optional) JavaScript Support -***************************** - -If you want to activate JavaScript support for the ZOO Kernel then you will have to use -the ``--with-js`` option. If you are using a "Debian-like" GNU/Linux distribution then -dpkg will be used to detect if the required packages are installed and you don't have to -specify anything here, so you can use the following command: - -:: - - $ ./configure --with-js - -This assumes that js_api.h and libmozjs.so are found in default directories. - -If you have a custom installation of SpiderMonkey or you are not using a Debian packaging -system, then you'll have to specify the directory where you installed it. For -instance, let's suppose that you installed your SpiderMonkey in /usr, then you'll -have to use the following command: - -:: - - $ ./configure --with-js=/usr - -This assumes that the /usr/include/js exists and contains the js_api.h headers file and -/usr/lib contains libmozjs.so file. Index: branches/PublicaMundi_David-devel/docs/kernel/install-windows.txt =================================================================== --- branches/PublicaMundi_David-devel/docs/kernel/install-windows.txt (revision 506) +++ (revision ) @@ -1,175 +1,0 @@ -.. _kernel-installation-windows: - -Windows -======= - -:Authors: Nicolas Bozon, Gérald Fenoy, Jeff McKenna -:Last Updated: $Date$ - -.. contents:: Table of Contents - :depth: 2 - :backlinks: top - -Using OSGeo4W -------------- - -Install OSGeo4W -*************** - -Download the OSGeo4W installer from http://trac.osgeo.org/osgeo4w/, and install it with all the dependencies needed by your -services (GDAL/OGR for example). The following libs are required: FastCGI, libxml, Python, cURL. - -Install other tools and libraries -********************************* - -After installing OSGeo4W on your platform you'll need more GNU tools and libraries. `This package `__ -contains full dependencies required to compile on WIN32 platform and this one contains `full runtime dependencies to place `__ -in your c:\OSGeo4W\bin. - -Download and Install ZOO Kernel -******************************* - -Download the `binary version `__ of the ZOO Kernel for WIN32 then place it in the -``C:\OSGeo4W\bin`` directory. Don't forget to place a ``main.cfg`` file in the same directory, you can use a modified copy of -`this file `__. - -Deploy ZOO Services Providers -***************************** - -Your can use the binary version of the OGR Services Provider available from `here `__. -Then place the two libraries with their respective .zcfg files in your local ``C:\OSGeo4W\bin`` directory. - -Testing -******* - -Now you should be able to query your local ZOO Kernel. - -Compiling Using Your Own Libraries ----------------------------------- - -.. note:: - You must be sure to perform the :ref:`prerequisite steps ` before compiling the ZOO Kernel. - -The following steps are for use with the Microsoft Visual Studio compiler (and tested with MSVC 2008). - -1. Make sure the gnuwin32 tools ``bison.exe`` and ``flex.exe`` are found in your path. You can download the GNUwin32 tools `here `__. - -2. Modify the file ``zoo-project\zoo-kernel\nmake.opt`` to point to your local libraries. You can find a modified nmake.opt that points to local libs `here `__. - You can also find a modified ``zoo-project\zoo-kernel\makefile.vc`` file `here `__. - -3. Execute: - - :: - - nmake /f makefile.vc - -4. A file ``zoo_loader.cgi`` should be created. Note that if another file named ``zoo_loader.cgi.manifest`` is also created, you - will have to run another command: - - :: - - nmake /f makefile.vc embed-manifest - -5. Copy the files ``zoo_loader.cgi`` and ``main.cfg`` into your cgi-bin directory. - -6. Using the command prompt, test the zoo-kernel by executing the following command: - - :: - - D:\ms4w\Apache\cgi-bin> zoo_loader.cgi - - which should display a message such as: - - :: - - Content-Type: text/xml; charset=utf-8 - Status: 200 OK - - - - - Parameter <request> was not specified - - - -7. Edit the file ``cgi-bin/main.cfg`` so that it contains values describing your WPS service. An example of such - a file running on Windows is: - - :: - - [main] - encoding = utf-8 - version = 1.0.0 - serverAddress = http://localhost/ - lang = en-CA - tmpPath=/ms4w/tmp/ms_tmp/ - tmpUrl = /ms_tmp/ - - [identification] - title = The Zoo WPS Development Server - abstract = Development version of ZooWPS. See http://www.zoo-project.org - fees = None - accessConstraints = none - keywords = WPS,GIS,buffer - - [provider] - providerName=Gateway Geomatics - providerSite=http://www.gatewaygeomatics.com - individualName=Jeff McKenna - positionName=Director - role=Dev - adressDeliveryPoint=1101 Blue Rocks Road - addressCity=Lunenburg - addressAdministrativeArea=False - addressPostalCode=B0J 2C0 - addressCountry=ca - addressElectronicMailAddress=info@gatewaygeomatics.com - phoneVoice=False - phoneFacsimile=False - -8. Open a web browser window, and execute a GetCapababilites request on your WPS service: http://localhost/cgi-bin/zoo_loader.cgi?request=GetCapabilities&service=WPS - - The response should be displayed in your browser, such as: - - :: - - - - The Zoo WPS Development Server - - Development version of ZooWPS. See http://www.zoo-project.org - - - WPS - GIS - buffer - - WPS - 1.0.0 - ... - -Optionally Compile Individual Services -************************************** - -An example could be the ``OGR base-vect-ops`` provider in the ``zoo-project\zoo-services\ogr\base-vect-ops`` directory. - -1. Edit the makefile.vc located in that directory, and execute: - - :: - - nmake /f makefile.vc - - Inside that same directory, the file ``cgi-env\ogr_service.zo`` should be created. - -2. Copy all of the files inside ``zoo-services\ogr\base-vect-ops\cgi-env`` into your cgi-bin directory - -3. Test this service provider through the following URL: - - http://localhost/cgi-bin/zoo_loader.cgi?request=Execute&service=WPS&version=1.0.0&Identifier=Buffer&DataInputs=BufferDistance=1@datatype=interger;InputPolygon=Reference@xlink:href=http%3A%2F%2Fwww.zoo-project.org%3A8082%2Fgeoserver%2Fows%3FSERVICE%3DWFS%26REQUEST%3DGetFeature%26VERSION%3D1.0.0%26typename%3Dtopp%3Astates%26SRS%3DEPSG%3A4326%26FeatureID%3Dstates.15 - - The response displayed in your browser should contain: - - :: - - Service "Buffer" run successfully. - Index: branches/PublicaMundi_David-devel/docs/kernel/installation.txt =================================================================== --- branches/PublicaMundi_David-devel/docs/kernel/installation.txt (revision 506) +++ (revision ) @@ -1,22 +1,0 @@ -.. _kernel-installation: - -Installation -============ - -:Authors: Nicolas Bozon, Gérald Fenoy, Jeff McKenna -:Last Updated: $Date$ - -This page provides documentation on how to compile then install the ZOO Kernel on Unix, Windows, and Mac OS X platforms. - -.. toctree:: - :maxdepth: 2 - - install-prerequisites - install-unix - install-opensuse - install-centos - install-debian - install-windows - install-mac - - Index: branches/PublicaMundi_David-devel/docs/kernel/introduction.txt =================================================================== --- branches/PublicaMundi_David-devel/docs/kernel/introduction.txt (revision 506) +++ (revision ) @@ -1,52 +1,0 @@ -.. _kernel-introduction: - -Introduction -============ - -:Authors: Nicolas Bozon, Gérald Fenoy, Jeff McKenna -:Last Updated: $Date$ - -ZOO Kernel is the heart of the ZOO. It is a powerful server-side C Kernel which makes -it possible to manage and chain Web services, by loading dynamic libraries and handling -them as on-demand Web services. The ZOO Kernel is written in the C language, but supports -several common programming languages in order to connect to numerous libraries and models. - -Using ZOO Kernel as a Web Processing Platform ---------------------------------------------- - -ZOO Kernel works with Apache and can communicate with cartographic engines and Web mapping -clients. It simply adds the WPS support to your spatial data infrastructure and your -Web mapping application! - -.. note:: - If you'd like some background on the WPS standard, head to: http://www.opengeospatial.org/standards/wps - -Supported Languages -------------------- - -ZOO Kernel supports the following programming languages, and let's you use them to create -new ZOO Services from new or existing code: - -============ =================== ========================= ============ -**Language** **ServiceProvider** **DataStructure** **Return** ------------- ------------------- ------------------------- ------------ -C / C++ Shared Library maps* M integer -Fortran Shared Library CHARACTER*(1024) M(10,30) integer -Java Class File `HashMap`_ integer -Python Module File `dictionary`_ integer -PHP Script File `Array`_ integer -Perl Script File integer -JavaScript Script file `Object`_ or Array Array/Object -============ =================== ========================= ============ - -.. _`HashMap`: http://download.oracle.com/javase/6/docs/api/java/util/HashMap.html -.. _`dictionary`: http://docs.python.org/tutorial/datastructures.html#dictionaries -.. _`Array`: http://php.net/manual/language.types.array.php -.. _`Object`: http://www.json.org/ - -ZOO Kernel is a WPS Espresso Machine ------------------------------------- - -.. image:: ../_static/images/zoo_kernel_scheme.png - - Index: branches/PublicaMundi_David-devel/docs/kernel/mapserver.rst =================================================================== --- branches/PublicaMundi_David-devel/docs/kernel/mapserver.rst (revision 659) +++ branches/PublicaMundi_David-devel/docs/kernel/mapserver.rst (revision 659) @@ -0,0 +1,255 @@ +.. _kernel-mapserver: + +Optional MapServer support +========================== + +Processing geospatial data using WPS Services is usefull. Publishing their results directly as WMS, WFS or WCS ressources is even more convenient. This is possible since `ZOO-Project 1.3 `__ using the **optional MapServer support**. The latter thus allows for automatic publication of WPS Service output as WMS/WFS or WCS using a :ref:`kernel_index` specific internal mechanism which is detailed in this section. + + +.. note:: + + |mapserver| `MapServer `__ is an open source WMS/WFS/WCS server. Learn more by reading its `documentation `__. + + +.. |mapserver| image:: ../_static/mapserver.png + :height: 74px + :width: 74px + :scale: 50% + :alt: MapServer logo + + +How does it work ? +------------------------- + +If a request with ``mimeType=image/png`` is sent to :ref:`kernel_index`, the latter will detect that the *useMapServer* option is set to true an it will automatically: + + * Execute the service using the ** block definition (these values must be understood by `GDAL `__) + * Store the resulting output on disk (in the ``[main]`` > ``dataPath`` directory) + * Write a `mapfile `__ (in the ``[main]`` > ``dataPath`` directory) using the `MapServer `__ C-API (this sets up both WMS and WFS services). + +Existing WPS Services source code doesn't need to be modified once the MapServer support is activated. It only takes to edit their respective :ref:`services-zcfg` files accordingly. + +.. note:: In case of a vector data source output, both WMS and WFS configuration are included by default in the resulting mapfile. + +.. note:: In case of a raster data source output, both WMS and WCS configuration are included by default in the resulting mapfile. + +Depending on the requests, ZOO-Kernel is able to return a location header and different request types: + + * ResponseDocument=XXXX@asReference=true + +In this case, ZOO-Kernel will return the GetMap/GetFeature/GetCoverage request as KVP in the *href* of the result. + + * ResponseDocument=XXXX@asReference=false + +In this case, ZOO-Kernel will return the result of the GetMap/GetFeature/GetCoverage request as KVP of the href used in the previous case. + + * RawDataOutput=XXXX@asReference=true/false + +In this case, ZOO-Kernel will return the GetMap/GetFeature/GetCoverage request as KVP in a specific location header, which implies that the browser is supposed to request MapServer directly. + +Whatever the default output *mimeType* returned by a WPS service is, it is used if the *useMapserver* option is found at runtime. As an example, if ```` and ```` blocks are found in the ZOO Service configuration file as shown bellow, this means that the service returns GML 3.1.0 features by default. + +.. code-block:: guess + + + mimeType = text/xml + encoding = UTF-8 + schema = http://schemas.opengis.net/gml/3.1.0/base/feature.xsd + + + mimeType = image/png + useMapserver = true + + +Installation and configuration +------------------------------ + +Follow the step described bellow in order to activate the ZOO-Project optional MapServer support. + +Prerequisites +............. + + * latest `ZOO-Kernel `__ trunk version + * `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 + +Then uncompress the MapServer archive (ie. ``mapserver-6.0.1.tar.bz2``) into ``/tmp/zoo-ms-src``, and compile it using the following command: + +.. code-block:: guess + + cd /tmp/zoo-ms-src/mapserver-6.0.1 + ./configure --with-ogr=/usr/bin/gdal-config --with-gdal=/usr/bin/gdal-config \ + --with-proj --with-curl --with-sos --with-wfsclient --with-wmsclient \ + --with-wcs --with-wfs --with-postgis --with-kml=yes --with-geos \ + --with-xml --with-xslt --with-threads --with-cairo + make + 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 + 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 + + +Main configuration file +........................ + +Open and edit the ``/usr/lib/cgi-bin/main.cfg`` file, by adding the following content in the ``[main]`` section: + +.. code-block:: guess + + dataPath = /var/www/temp/ + mapserverAddress=http://localhost/cgi-bin/mapserv + +The ``dataPath`` directory is mandatory and must belong to the Apache user. + +.. code-block:: guess + + mkdir /var/www/temp/ + chown -r apache:apache /var/www/temp/ + +A ``symbols.sym`` file is required in this directory. Create it and add the following content in it: + +.. code-block:: guess + + SYMBOLSET + SYMBOL + NAME "circle" + TYPE ellipse + FILLED true + POINTS + 1 1 + END + END + END + +.. note:: + Only one symbol definition is required (with any name) for the WMS service output. + +The ZOO-Project optional MapServer support is activated at this step. Don't forget to add the ``mapserverAddress`` and ``msOgcVersion`` parameters to the ``main.cfg`` file in order to to specify the path to MapServer and the OGC WebService version used by the Services. + +.. code-block:: guess + mapserverAddress=http://localhost/cgi-bin/mapserv.cgi + msOgcVersion=1.0.0 + +.. warning:: + ZOO-kernel will segfault (checking ``NULL`` value should correct this behavior) if the ``mapserverAddress`` parameter is not found + + +Service configuration file +............................ + +useMapserver +************* + +In order to activate the MapServer WMS/WFS/WCS output for a specific service, the ``useMapserver`` parameter must be added to the ```` or ```` blocks of the Service `services-zcfg`. If ``useMapserver=true``, this means that the output result of the Service is a GDAL compatible datasource and that you want it to be automatically published by MapServer as WMS,WFS or WCS. + +When the useMapserver option is used in a ```` or ```` block, then you have to know what are the corresponding mimeType: + + * text/xml: Implies that the output data will be accessible through a WFS GetFeature request (default protocol version 1.1.0) + * image/tiff: Implies that the output data will be accessible through a WCS GetCoverage request (default protocol version 2.0.0) + * any other mimeType coupled with useMapserver option: Implies that the output data will be accessible through a WMS GetMap request (default protocol version 1.3.0). You can check the supported output mimeType by sending a GetCapabilities request to MapServer. + + +You get the same optional parameter ``msOgcVersion`` as for the ``main.cfg``. This will specify that this is the specific protocol version the service want to use (so you may set also locally to service rather than globally). + +Styling +************* + +The optional ``msStyle`` parameter can also be used to define a custom MapServer style block (used for vector datasource only), as follow: + +.. code-block:: guess + + 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 = .... + +Example +************** + +An example :ref:`services-zcfg` file configured for the optional MapServer support is shown bellow: + +.. code-block:: guess + + + mimeType = text/xml + encoding = UTF-8 + schema = http://schemas.opengis.net/gml/3.1.0/base/feature.xsd + useMapserver = true + + + mimeType = image/png + useMapserver = true + asReference = true + msStyle = STYLE COLOR 125 0 105 OUTLINECOLOR 0 0 0 WIDTH 3 END + + + mimeType = application/vnd.google-earth.kmz + useMapserver = true + asReference = true + msStyle = STYLE COLOR 125 0 105 OUTLINECOLOR 0 0 0 WIDTH 3 END + + + mimeType = image/tif + useMapserver = true + asReference = true + msClassify = .... + + +In this example, the default output ``mimeType`` is ``image/png``, so a WMS GetMap request will be returned, or the resulting ``image/tiff`` will be returned as WCS GetCoverage request. + + +Test requests +-------------- + +The optional MapServer support can be tested using any service. The +simple *HelloPy* Service is used in the following example requests. + +.. note:: + The following examples require a zip file containing a Shapefile (http://localhost/data/data.zip) and a tif file (http://localhost/data/demo.tif) + +Accessing a remote Zipped Shapefile as WFS GetFeatures Request: + +.. code-block:: guess + + http://localhost/cgi-bin/zoo_loader.cgi?request=Execute&service=WPS&version=1.0.0&Identifier=HelloPy&DataInputs=a=Reference@xlink:href=http://localhost/data/data.zip&ResponseDocument=Result@asReference=true@mimetype=text/xml + +Accessing a remote Zipped Shapefile as WMS GetMap Request: + +.. code-block:: guess + + http://localhost/cgi-bin/zoo_loader.cgi?request=Execute&service=WPS&version=1.0.0&Identifier=HelloPy&DataInputs=a=Reference@xlink:href=http://localhost/data/data.zip&ResponseDocument=Result@asReference=true@mimetype=image/png + +Accessing a remote tiff as WMS GetMap Request: + +.. code-block:: guess + + http://localhost/cgi-bin/zoo_loader.cgi?request=Execute&service=WPS&version=1.0.0&Identifier=HelloPy&DataInputs=a=Reference@xlink:href=http://localhost/data/data.tiff&ResponseDocument=Result@asReference=true@mimetype=image/png + +Accessing a remote tiff as WCS GetMap Request: + +.. code-block:: guess + + http://localhost/cgi-bin/zoo_loader.cgi?request=Execute&service=WPS&version=1.0.0&Identifier=HelloPy&DataInputs=a=Reference@xlink:href=http://localhost/data/data.tiff&ResponseDocument=Result@asReference=true@mimetype=image/tiff + + Index: branches/PublicaMundi_David-devel/docs/kernel/mapserver.txt =================================================================== --- branches/PublicaMundi_David-devel/docs/kernel/mapserver.txt (revision 506) +++ (revision ) @@ -1,264 +1,0 @@ -.. _kernel-mapserver: - -How To Use the Internal MapServer W*S support -============================================= - -:Authors: Nicolas Bozon, Gérald Fenoy, Jeff McKenna -:Last Updated: $Date$ - -The key idea of the MapServer W*S support implementation is that it -doesn't require to change a single line of the service source code to -activate the automatic publication of your result as WMS/WFS or WCS -ressource. You simply need to modify the ``zcfg`` file corresponding -to your service to make it working. - -Here is an overview of the way to install the MapServer W*S support, the -configuration required and the internal mechanisms. - -.. contents:: Table of Contents - :depth: 3 - :backlinks: top - -How to make it working ? ------------------------- - -Requirement -************** - - * last ZOO-Kernel trunk version - * MapServer version >= 6.0.1 - -Installation steps -******************** - -First download lastest zoo-kernel directory available on the svn, do that from the directory of your previous checkout (so where zoo-api, zoo-services and zoo-kernel directories are available), we will use ```` here for this directory: - -.. code-block:: guess - - cd - svn checkout http://svn.zoo-project.org/svn/trunk/zoo-kernel zoo-kernel-ms - -Uncompress the MapServer archive (ie. ``mapserver-6.0.1.tar.bz2``) into ``/tmp/zoo-ms-src``, then compile MapServer using the following command: - -.. code-block:: guess - - cd /tmp/zoo-ms-src/mapserver-6.0.1 - ./configure --with-ogr=/usr/bin/gdal-config --with-gdal=/usr/bin/gdal-config \ - --with-proj --with-curl --with-sos --with-wfsclient --with-wmsclient \ - --with-wcs --with-wfs --with-postgis --with-kml=yes --with-geos \ - --with-xml --with-xslt --with-threads --with-cairo - make - cp mapserv /usr/lib/cgi-bin - -Autotools was updated to add the ``--with-mapserver`` configure option. From your ZOO-Project SVN trunk directory, compile the ZOO-Kernel using the following command: - -.. code-block:: guess - - cd zoo-kernel-ms - autoconf - ./configure --with-python --with-mapserver=/tmp/zoo-ms-src/mapserver-6.0.1 - make - cp zoo_loader.cgi /usr/lib/cgi-bin - -Configuration steps -************************* - -Main configuration file -^^^^^^^^^^^^^^^^^^^^^^^ - -Add the following content to your ``/usr/lib/cgi-bin/main.cfg`` file - in the ``[main]`` section: - -.. code-block:: guess - - dataPath = /var/www/temp/ - mapserverAddress=http://localhost/cgi-bin/mapserv - -The ``dataPath`` directory should exists and be writable by apache user. In this directory, a ``symbols.sym`` file have to be present, containing the following: - -.. code-block:: guess - - SYMBOLSET - SYMBOL - NAME "circle" - TYPE ellipse - FILLED true - POINTS - 1 1 - END - END - END - -Only one symbol definition is required with any name, used for WMS service output. - -Now, your ZOO-Kernel get the MapServer support ready to be used. Note that if you don't add the ``mapserverAddress`` then it imply the ZOO-Kernel will segfault (checking ``NULL`` value should correct this behavior). - -Here you can optionally add a ``msOgcVersion`` parameter to specify which version of the OGC WebService you want to use for each services. For example, if you want to force to version 1.0.0, you can set the following in the ``[main]`` section of your ``main.cfg`` file: - -.. code-block:: guess - - msOgcVersion=1.0.0 - -Service configuration file -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -To activate MapServer WebServices output for a service, you have to add a specific parameter in the ```` or ```` block: ``useMapserver``. This can take the value true or should not appear. If true, it means that the output result is an OGR / GDAL compatible datasource and you want it to be outputted as an OGC web server instance (WMS/WFS/WCS). - -You get an optional parameter, to use a custom MapServer style block (used for vector datasource only): msStyle. For example: - -.. code-block:: guess - - msStyle = STYLE COLOR 125 0 105 OUTLINECOLOR 0 0 0 WIDTH 3 END - -You get the same optional parameter ``msOgcVersion`` as for the ``main.cfg``. This will specify that this is the specific protocol version the service want to use (so you may set also locally to service rather than globally). - -When you add useMapserver option to an output ```` or ```` block, then you have to know what are the sensible mimeType: - - * text/xml: will imply that the output data will be accessible through a WFS GetFeature request (default protocol version 1.1.0) - * image/tiff: will imply that the output data will be accessible through a WCS GetCoverage request (default protocol version 2.0.0) - * any other mimeType coupled with useMapserver option: will imply that the output data will be accessible trhough a WMS GetMap request (you have to limit yourself to what your MapServer installation support, GetCapabilities? request give information of supported output mimeType) (default protocol version 1.3.0) - -How does it work ? ---------------------- - -Whatever your service return as default output ``mimeType``, this one will be used when one output including the ``useMapserver`` option was found. - -So if you get the following ```` and ```` blocks in the ZOO Configuration File of your service: - -.. code-block:: guess - - - mimeType = text/xml - encoding = UTF-8 - schema = http://schemas.opengis.net/gml/3.1.0/base/feature.xsd - - - mimeType = image/png - useMapserver = true - - -It means that per default, your service return GML 3.1 Feature. When the client request for ``mimeType=image/png``, then the ZOO-Kernel will detect that this ``mimeType`` get the ``useMapServer`` option set to true so it will: - - 1) execute the service using the ```` block definition (this should be understandable by GDAL/OGR) - - 2) store the result of the service on disk (in the ``[main]`` > ``dataPath`` directory) - - 3) write a Mapfile (in the ``[main]`` > ``dataPath`` directory) using the MapServer C-API to setup both WMS and WFS services. - -.. Note:: even if you don't ask for this, the resulting Mapfile includes both configuration for WMS and WFS in case of Vector datasource. - -If your service output a raster file, then the behavior is quite the same except that the ZOO-Kernel will setup both WMS and WCS services for the result of the service. Here you cannot define your own style. Nevertheless, when one band raster is returned then the ZOO-Kernel can use its own default style definitions to classify the raster using equivalent intervals (you can easily see that in the outputed Mapfile), this classification is specific to WMS protocol. You should add a ``msClassify`` parameter and set it to ``true`` in your output ComplexData ```` or ```` node to activate this classification. -Special note for client implementers - -Note that depending on the request, the ZOO-Kernel can return a location header. - -Differente request types: - - * ResponseDocument=XXXX@asReference=true - in this case, the Kernel will return the GetMap/GetFeature/GetCoverage request in KVP in the href of the result. - * ResponseDocument=XXXX@asReference=false - in this case, the Kernel will return the result he get using the GetMap/GetFeature/GetCoverage request in KVP used for the href in previous case. - * RawDataOutput=XXXX@asReference=true/false - in this case, the Kernel will return the GetMap/GetFeature/GetCoverage request in KVP in the specific location header, which imply that the browser should follow and request MapServer directly. - -Simple sample use cases ------------------------ - -Consider the existing BufferPy service from zoo-services/ogr-base-vect-ops-py. Set the following content to your local BufferPy.zcfg file in the Result output definition, then copy it to /usr/lib/cgi-bin/: - -.. code-block:: guess - - - mimeType = text/xml - encoding = UTF-8 - schema = http://schemas.opengis.net/gml/3.1.0/base/feature.xsd - useMapserver = true - - - mimeType = image/png - useMapserver = true - asReference = true - msStyle = STYLE COLOR 125 0 105 OUTLINECOLOR 0 0 0 WIDTH 3 END - - - mimeType = image/tif - useMapserver = true - asReference = true - msStyle = STYLE COLOR 125 0 105 OUTLINECOLOR 0 0 0 WIDTH 3 END - - - mimeType = application/vnd.google-earth.kmz - useMapserver = true - asReference = true - msStyle = STYLE COLOR 125 0 105 OUTLINECOLOR 0 0 0 WIDTH 3 END - - -This modifications make your service ready to return result as WMS GetMap or WFS GetFeature requests. Note that some bug occurs locally using the application/vnd.google-earth.kmz output. -Raster - -Using the following simple service code we get a service capable to output any kind of internet files (useful for testing this functionality): - -.. code-block:: guess - - import zoo - def HelloPy(conf,inputs,outputs): - outputs["Result"]["value"]=inputs["a"]["value"] - return zoo.SERVICE_SUCCEEDED - -Define the ``[Result]`` output in your ``HelloPy.zcfg`` file with the following ComplexData block content: - -.. code-block:: guess - - - mimeType = image/png - useMapServer = true - - - mimeType = image/tiff - useMapServer = true - - - mimeType = text/xml - useMapServer = true - - -It means that the default output ``mimeType`` is ``image/png``, so a WMS GetMap request will be returned, or the resulting ``image/tiff`` will be returned as WCS GetCoverage request. - -With this simple service you can test the new capabilities to output result as WebServices for each mimeTypes. Note, that you'll probably get wrong ``mimeType``, as the default was set to ``image/png``. - -There is a support for Zipped ShapeFile but I doubt it is really -useful. Anyway, as it is present you can test it easily by passing a -zip file in ``xlink:href`` for the ``a`` value of the ``HelloPy`` -service. - -Testings -*********** - -Using the simple ``HelloPy`` service code, you can use the following urls, note it supposes that you get an available http://localhost/data/data.zip file containing a ShapeFile and a http://localhost/data/demo.tif: - -Test 1: Accessing a remote Zipped Shapefile as WFS GetFeatures Request -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. code-block:: guess - - http://localhost/cgi-bin/zoo_loader.cgi?request=Execute&service=WPS&version=1.0.0&Identifier=HelloPy&DataInputs=a=Reference@xlink:href=http://localhost/data/data.zip&ResponseDocument=Result@asReference=true@mimetype=text/xml - -Test 2: Accessing a remote Zipped Shapefile as WMS GetMap Request -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. code-block:: guess - - http://localhost/cgi-bin/zoo_loader.cgi?request=Execute&service=WPS&version=1.0.0&Identifier=HelloPy&DataInputs=a=Reference@xlink:href=http://localhost/data/data.zip&ResponseDocument=Result@asReference=true@mimetype=image/png - -Test 3: Accessing a remote tiff as WMS GetMap Request: -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. code-block:: guess - - http://localhost/cgi-bin/zoo_loader.cgi?request=Execute&service=WPS&version=1.0.0&Identifier=HelloPy&DataInputs=a=Reference@xlink:href=http://localhost/data/data.tiff&ResponseDocument=Result@asReference=true@mimetype=image/png - -Test 4: Accessing a remote tiff as WCS GetMap Request: -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. code-block:: guess - - http://localhost/cgi-bin/zoo_loader.cgi?request=Execute&service=WPS&version=1.0.0&Identifier=HelloPy&DataInputs=a=Reference@xlink:href=http://localhost/data/data.tiff&ResponseDocument=Result@asReference=true@mimetype=image/tiff - - Index: branches/PublicaMundi_David-devel/docs/kernel/orfeotoolbox.rst =================================================================== --- branches/PublicaMundi_David-devel/docs/kernel/orfeotoolbox.rst (revision 659) +++ branches/PublicaMundi_David-devel/docs/kernel/orfeotoolbox.rst (revision 659) @@ -0,0 +1,131 @@ +.. _kernel-orfeotoolbox: + +Optional Orfeo Toolbox support +====================== + +`Orfeo Toolbox `_ provides simple to advanced algorithms for processing imagery available from remote sensors. +The optional Orfeo Toolbox support is available since `ZOO-Project 1.5 +`__. It allows to execute the `OTB Applications `_ directly as ZOO WPS Services thanks to a :ref:`kernel_index` specific internal mechanism which is detailed in this section. + +.. note:: + + |otb| `Orfeo Toolbox `__ is an open source image processing library. Learn more by reading its `documentation `__. + + +.. |otb| image:: ../_static/orfeotoolbox.png + :height: 115px + :width: 150px + :scale: 30% + :alt: Orfeo Toolbox logo + + +Installation and configuration +------------------------------ + +Follow the step described bellow in order to activate the ZOO-Project +optional Orfeo Toolbox support. + +Prerequisites +............. + + * latest `ZOO-Kernel `_ trunk version + * Orfeo Toolbox (`OTB 4.2.1 `_ ) + * Insight Segmentation and Registration Toolkit (`ITK-4.7 `_ ) + +Installation steps +........................... + +.. Note:: These installation steps were successfully tested on Ubuntu 14.4 LTS + +.. Note:: For OTB and ITK, the CMAKE_C_FLAGS and CMAKE_CXX_FLAGS must first be set to ``-fPIC`` + +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: + +.. code-block:: guess + + cd zoo-kernel + autoconf + ./configure --with-otb=/usr/local --with-itk=/usr/local --with-itk-version=4.7 + make + cp zoo_loader.cgi /usr/lib/cgi-bin + +Configuration steps +************************* + +Main configuration file +^^^^^^^^^^^^^^^^^^^^^^^ + +Add the following content to your ``/usr/lib/cgi-bin/main.cfg`` file +in the ``[env]`` section: + +.. code-block:: guess + + ITK_AUTOLOAD_PATH=/usr/local/lib/otb/applications + +Services configuration file +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The build of the `otb2zcfg `_ utility is required to activate the available OTB Applications as WPS services. This can be done using the following command: + +.. code-block:: guess + + mkdir build + cd build + ccmake .. + make + +Run the following command to generate all the needed zcfg files for the available OTB Application: + +.. code-block:: guess + + mkdir zcfgs + cd zcfgs + export ITK_AUTOLOAD_PATH=/your/path/to/otb/applications + ../build/otb2zcfg + mkdir /location/to/your/cgi-bin/OTB + cp *zcfg /location/to/your/cgi-bin/OTB + +.. warning + + The ITK_AUTOLOAD_PATH environment variable is required in the [env] section of your main.cfg. + +Test the ZOO OTB support +^^^^^^^^^^^^^^^^^^^^^^^ + +Once done, OTB Applications should be listed as available WPS Services when runing a GetCapabilities request + +.. code-block:: guess + + http://localhost/cgi-bin/zoo_loader.cgi?request=GetCapabilities&service=WPS + +Each OTB Service can then be described individually using the DescribeProcess request, as for example: + +.. code-block:: guess + + http://localhost/cgi-bin/zoo_loader.cgi?request=DescribeProcess&service=WPS&version=1.0.0&Identifier=OTB.BandMath + +As an example, here is a test request executing the OTB.BandMath Application with the OTB Cookbook sample data as input + +.. code-block:: guess + + http://localhost/cgi-bin/zoo_loader.cgi?request=Execute&service=WPS&version=1.0.0&Identifier=OTB.BandMath&DataInputs=il=Reference@xlink:href=http://hg.orfeo-toolbox.org/OTB-Data/raw-file/ca154074b282/Examples/verySmallFSATSW.tif;il=Reference@xlink:href=http://hg.orfeo-toolbox.org/OTB-Data/raw-file/ca154074b282/Examples/verySmallFSATSW_nir.tif;out=float;exp=im1b3*cos%28im1b1%29,im1b2*cos%28im1b1%29,im1b1*cos%28im1b1%29&RawDataOutput=out@mimeType=image/png + + +.. note:: + When executing OTB applications as WPS Services, it is also possible to check the OTB process status, using the usual ZOO GetStatus request. + + + + + + + + + + Index: branches/PublicaMundi_David-devel/docs/kernel/sagagis.rst =================================================================== --- branches/PublicaMundi_David-devel/docs/kernel/sagagis.rst (revision 659) +++ branches/PublicaMundi_David-devel/docs/kernel/sagagis.rst (revision 659) @@ -0,0 +1,134 @@ +.. _kernel-sagagis: + +Optional SAGA GIS support +====================== + +`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| image:: ../_static/sagagis.png + :height: 100px + :width: 100px + :scale: 45% + :alt: SAGA GIS logo + + +How does it work ? +------------------------- + + + +Installation and configuration +------------------------------ + +Follow the step described bellow in order to activate the ZOO-Project optional SAGA GIS support. + +Prerequisites +............. + + * latest `ZOO-Kernel `_ trunk version + * SAGA GIS (`SAGA-GIS 2.1.4 `_ ) + * libLAS-1.2 (`LibLAS-1.2 `_ ) + +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: + +.. code-block:: guess + + cd zoo-kernel + autoconf + ./configure --with-saga=/usr/local/ + make + +And copy the newly created zoo_loader.cgi to ``/usr/lib/cgi-bin`` : + +.. code-block:: guess + + cp zoo_loader.cgi /usr/lib/cgi-bin + +Configuration steps +************************* + +Main configuration file +^^^^^^^^^^^^^^^^^^^^^^^ + +Add the following content to your ``/usr/lib/cgi-bin/main.cfg`` file +in the ``[env]`` section: + +.. code-block:: guess + + ITK_AUTOLOAD_PATH=/usr/local/lib/otb/applications + +Services configuration file +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The build of the `otb2zcfg `_ utility is required to activate the available OTB Applications as WPS services. This can be done using the following command: + +.. code-block:: guess + + mkdir build + cd build + ccmake .. + make + +Run the following command to generate all the needed zcfg files for the available OTB Application: + +.. code-block:: guess + + mkdir zcfgs + cd zcfgs + export ITK_AUTOLOAD_PATH=/your/path/to/otb/applications + ../build/otb2zcfg + mkdir /location/to/your/cgi-bin/OTB + cp *zcfg /location/to/your/cgi-bin/OTB + +.. warning + + The ITK_AUTOLOAD_PATH environment variable is required in the [env] section of your main.cfg. + +Test the ZOO SAGA support +^^^^^^^^^^^^^^^^^^^^^^^ + +Once done, OTB Applications should be listed as available WPS Services when runing a GetCapabilities request + +.. code-block:: guess + + http://localhost/cgi-bin/zoo_loader.cgi?request=GetCapabilities&service=WPS + +Each OTB Service can then be described individually using the DescribeProcess request, as for example: + +.. code-block:: guess + + http://localhost/cgi-bin/zoo_loader.cgi?request=DescribeProcess&service=WPS&version=1.0.0&Identifier=OTB.BandMath + +And executed according to your needs, as for the following example executing OTB.BandMath with the OTB sample data as input + +.. code-block:: guess + + http://localhost/cgi-bin/zoo_loader.cgi?request=Execute&service=WPS&version=1.0.0&Identifier=OTB.BandMath&DataInputs=il=Reference@xlink:href=http://hg.orfeo-toolbox.org/OTB-Data/raw-file/ca154074b282/Examples/verySmallFSATSW.tif;il=Reference@xlink:href=http://hg.orfeo-toolbox.org/OTB-Data/raw-file/ca154074b282/Examples/verySmallFSATSW_nir.tif;out=float;exp=im1b3*cos%28im1b1%29,im1b2*cos%28im1b1%29,im1b1*cos%28im1b1%29&RawDataOutput=out@mimeType=image/png + +When executing OTB applications as WPS Services, it is also possible to check the OTB process status, using the usual ZOO GetStatus request. + + + + + + + + + + Index: branches/PublicaMundi_David-devel/docs/kernel/what.rst =================================================================== --- branches/PublicaMundi_David-devel/docs/kernel/what.rst (revision 659) +++ branches/PublicaMundi_David-devel/docs/kernel/what.rst (revision 659) @@ -0,0 +1,53 @@ +.. kernel-what: + +.. include:: +.. include:: + +What is ZOO-Kernel ? +==================== + +ZOO-Kernel is the heart of the `ZOO-Project `_ WPS platform. It is a WPS compliant implementation written in C language which provides a powerful and extensible WPS server. + +ZOO-Kernel implements and complies with the `WPS 1.0.0 `_ standard edited by the `Open Geospatial Consortium `_. It is able to perform the WPS operations as indicated in the OpenGIS |reg| specification, as listed bellow: + +* **GetCapablities**: Returns service-level metadata information.It provides the list of available processing services. +* **DescribeProcess**: Returns a description of a process, including its supported input and output. +* **Execute**: Launches computation and returns the output produced by a particular process. + + +First class WPS server +----------------------- + +ZOO-Kernel is an extensible WPS server that makes your system more powerful. It provides a full-featured processing engine which runs on Linux, Mac OSX |trade| and Windows |trade| operating systems. ZOO-Kernel works on common web servers (namely `Apache `_ or `IIS `_ |trade|) and can be seamlessly integrated to new or existing web platforms. + +ZOO-Kernel lets you process geospatial or non geospatial data using well formed WPS requests. The WPS server is able to manage and chain WPS Services (see ZOO-Services for examples) by loading dynamic libraries and source code written in different programming languages. + +Supported programming languages +............................... + +ZOO-Kernel is a **polyglot**. The software is written in a valid form of multiple programming languages, which performs the same operations independent of the programming language used to compile or interpret it. + + +============ =================== ========================= ============ +**Language** **ServiceProvider** **DataStructure** **Return** +------------ ------------------- ------------------------- ------------ +C / C++ Shared Library maps* M integer +Java Class File `HashMap`_ integer +Python Module File `Dictionary`_ integer +PHP Script File `Array`_ integer +Perl Script File integer +Ruby Script File `Hash`_ integer +Fortran Shared Library CHARACTER*(1024) M(10,30) integer +JavaScript Script file `Object`_ or Array Object/Array +============ =================== ========================= ============ + +.. _`HashMap`: http://download.oracle.com/javase/6/docs/api/java/util/HashMap.html +.. _`dictionary`: http://docs.python.org/tutorial/datastructures.html#dictionaries +.. _`Array`: http://php.net/manual/language.types.array.php +.. _`Object`: http://www.json.org/ +.. _`Hash`: http://ruby-doc.org/core-2.2.0/Hash.html + + + + +