Changeset 663


Ignore:
Timestamp:
Jun 16, 2015, 11:59:50 AM (10 years ago)
Author:
nbozon
Message:

various enhancements and missing doc files

Location:
branches/PublicaMundi_David-devel/docs
Files:
2 added
1 deleted
8 edited

Legend:

Unmodified
Added
Removed

  • branches/PublicaMundi_David-devel/docs/contribute/code.rst

    r659 r663  
     1.. _contribute_code:
     2
    13Contribute code
    24===============
    35
    4 Anybody is welcome to share and contribute ideas, code, documentation or any relevant resource
    5 using the following media.
     6Anybody is welcome to share source code and to report bugs or feature requests using the following instructions.
    67
    78Submit new code
    89--------------------------
    910
     11For new comers
     12*************************
    1013
    11 Report a code issue
     14New source code or existing source code corrections (patches) should be submitted using the ZOO-Project bug tracking system (ZOO-Trac).
     15
     16Create a new ticket in order to describe your code or patch and attach it to the ticket (attach all the needed files needed to use your code or patch). It will then be checked and discussed with the developers, and can potentially be merged with the trunk.
     17
     18For registered developers
     19***************************
     20
     21ZOO-Project registered developers have direct svn access and can:
     22
     23* Commit fixes, enhancement and new source directly to trunk
     24 
     25* Create and commit to a new branch of the svn
     26
     27Bug tracking
    1228--------------------------
    1329
     30General information
     31*********************
    1432
     33Bug reports and wishes can be submitted using the ZOO-Trac. This requires you to setup a user account (userid) using this section.
     34
     35The following trackers are available:
     36
     37* *defects* to report bugs and 'bad' features
     38* *enhancement* to describe feature wishes
     39* *task* to describe any different but relevant topic.
     40
     41The following components are available:
     42
     43* *Developemnt platform* to report bugs and 'bad' features
     44* *ZOO-Kernel* to report a bug or problem with the ZOO-Project WPS server
     45* *ZOO-Services* to report a bug or problem with the ZOO-Project WPS services
     46* *ZOO-API* to report a bug or problem with the ZOO-Project API
     47* *ZOO-Client* to report a bug or problem with the ZOO-Project Client
     48* *Documentation* to report a problem or suggest an enhancement to the documentation
     49 
     50Best practices
     51*********************
     52
     53Please consider the following when submitting bugs or feature requests:
     54
     55* Check if the bug is still persistent in svn trunk before reporting. If you use an older version, please consider upgrading.
     56* Before reporting a bug, please search if it is yet unknown in the bug tracking system.
     57* Give an appropriate, starightforward and understandable title to your ticket using the *Summary* field   
     58* Make sure the developers get all the needed information to recreate the bug using the *Description* field (e.g. tell about your configuration and explain every step to reproduce the bug).
     59* Select at least a *Type* of tracker and a *Component* for your new ticket.
     60* Report only one single bug by ticket.
     61
     62

  • branches/PublicaMundi_David-devel/docs/contribute/howto.rst

    r659 r663  
    22==================
    33
    4 Please consider the following simple rules if you would like to
    5 contribute to `ZOO-Project <http://zoo-project.org>`__ .
    6 
     4Please consider the following simple rules if you would like to contribute to  the `ZOO-Project <http://zoo-project.org>`__  open source software.
    75
    86Community
    97-------------------
    108
    11 Anybody is welcome to share and contribute ideas, code, documentation
    12 or any relevant resource. This should be done according to the directives stated in the ZOO-Project :ref:`contribute_index`.
     9Anybody is welcome to share and contribute ideas, code, documentation or any relevant resource. This should be done according to the directives stated in the ZOO-Project :ref:`contribute_index`.
     10
     11Governance
     12......................................
     13
     14`ZOO-Project <http://zoo-project.org>`__ activities are directed by the Project Steering Committee (PSC) and the software itself is being developed, maintained and documented by an international community of users and developers (aka `ZOO-Tribe <http://zoo-project.org/new/ZOO-Project/ZOO%20Tribe>`_).
     15
     16Contributions are moderated and integrated in trunk at the discretion of the `ZOO-Project <http://zoo-project.org>`__ PSC. Commit access are usually granted to active contributors by vote from the PSC members.
    1317
    1418Licensing
    1519......................................
    1620
    17 `ZOO-Project <http://zoo-project.org>`__ source code is open source and
    18 made available under the `MIT/X-11
    19 <http://opensource.org/licenses/MITlicense>`__  `license
    20 <http://zoo-project.org/trac/browser/trunk/zoo-project/LICENSE>`__. You
    21 must agree to the terms of that same license when creating, submiting
    22 and releasing new source code.
     21`ZOO-Project <http://zoo-project.org>`__ source code is open source and made available under the `MIT/X-11 <http://opensource.org/licenses/MITlicense>`__  `license
     22<http://zoo-project.org/trac/browser/trunk/zoo-project/LICENSE>`__. You must agree to the terms of that same license when creating, submiting and releasing new source code.
    2323
    24 `ZOO-Project <http://zoo-project.org>`__ documentation is open source and
    25 made available under the `Creative Commons Attribution-ShareAlike 4.0 International Public License
    26 <https://creativecommons.org/licenses/by-sa/4.0/legalcode>`__ . You
    27 must agree to the terms of that same license when creating, submiting
    28 and releasing a new documentation file.
    29 
    30 
    31 Governance
    32 ......................................
    33 
    34 
     24`ZOO-Project <http://zoo-project.org>`__ documentation is open source and made available under the `Creative Commons Attribution-ShareAlike 4.0 International Public License
     25<https://creativecommons.org/licenses/by-sa/4.0/legalcode>`__ . You must agree to the terms of that same license when creating, submiting and releasing a new documentation file.
    3526
    3627Available media
    3728-------------------
    3829
    39 Discussions and contributions are encouraged using the following media
     30Discussions and contributions to `ZOO-Project <http://zoo-project.org>`__ are encouraged using the following public media.
    4031
    4132Mailing lists
    4233......................................
    4334
    44 Post any feedback, comment or idea to the general public mailing
    45 list. For project managment or governance topics, use the PSC list.
     35Feel free to post any question, feedback, comment or idea to the general public mailing list. For project managment or governance topics, please use the PSC list.
    4636
    4737..   csv-table::
    … …  
    5545......................................
    5646
    57 Join #zoo-project channel on irc.freenode.net to discuss with the ZOO-Tribe
     47Join the **#zoo-project** channel on irc.freenode.net to discuss with the ZOO-Tribe at any time.
    5848
    5949
    60 Tracker and wiki
     50Tracker
    6151......................................
    6252
    63 Contributions and bug reports should be shared using the `ZOO-Project
    64 <http://zoo-project.org>`__ bug tracking system, as specified in the
    65 :ref:`contribute-code` section. Wiki pages can also be created to
    66 describe contributions and or actions.
     53Bug reports and code patches should be shared using the `ZOO-Project <http://zoo-project.org>`__ bug tracking system, as specified in the :ref:`contribute-code` section.
     54
     55Wiki
     56......................................
     57
     58Wiki pages can also be created by registered users. They can be used in order to describe any concept, contribution and or action that benefits or is related to the project.

  • branches/PublicaMundi_David-devel/docs/contribute/index.rst

    r659 r663  
    1515   howto
    1616   code
     17   doc

  • branches/PublicaMundi_David-devel/docs/install/install-prerequisites.rst

    r659 r663  
    1717- OpenSSL (  http://www.openssl.org )
    1818- Python (  http://www.python.org )
     19- GDAL (for using the available GDAL based ZOO-Services) (http://gdal.org/)
    1920
    2021 .. warning::
    … …  
    3233- SAGA GIS (for ZOO-Kernel optional SAGA support)(http://www.saga-gis.org/en/index.html/)
    3334- OrfeoToolbox (for ZOO-Kernel optional OTB support) (https://www.orfeo-toolbox.org/)
     35- Insight Segmentation and Registration Toolkit  (http://itk.org/ITK/resources/software.html/>)
    3436- GRASS GIS (for using it through WPSGrassBridge) (http://grass.osgeo.org)
    35 - GDAL (for using the available GDAL based ZOO-Services) (http://gdal.org/)
     37

  • branches/PublicaMundi_David-devel/docs/intro.rst

    r659 r663  
    3434-------------------
    3535
    36 `ZOO-Project <http://zoo-project.org>`__  is open source and released under the terms of the `MIT/X-11 <http://opensource.org/licenses/MITlicense>`__  `license <http://zoo-project.org/trac/browser/trunk/zoo-project/LICENSE>`__ . ZOO-Project activities are directed by the Project Steering Committee (PSC) and the software itself is being developed, maintained and documented by an international `community <http://zoo-project.org/new/ZOO-Project/ZOO%20Tribe>`__ of users and developers.
     36`ZOO-Project <http://zoo-project.org>`__  is open source and released under the terms of the `MIT/X-11 <http://opensource.org/licenses/MITlicense>`__  `license <http://zoo-project.org/trac/browser/trunk/zoo-project/LICENSE>`__ . ZOO-Project activities are directed by the Project Steering Committee (PSC) and the software itself is being developed, maintained and documented by an international community of users and developers (aka `ZOO-Tribe <http://zoo-project.org/new/ZOO-Project/ZOO%20Tribe>`_).
    3737
    3838Please refer to the ZOO-Project :ref:`contribute_index` if you want to participate and contribute. It is easy to `get involved <http://zoo-project.org/new/Get involved/>`__ on code, documentation or translation, and everybody is welcome in the `ZOO-Tribe <http://zoo-project.org/new/ZOO-Project/ZOO%20Tribe/>`__.

  • branches/PublicaMundi_David-devel/docs/kernel/orfeotoolbox.rst

    r659 r663  
    55
    66`Orfeo Toolbox <http://orfeo-toolbox.org/otb/>`_ provides simple to advanced algorithms for processing imagery available from remote sensors.
    7 The optional Orfeo Toolbox support is available since `ZOO-Project 1.5
    8 <http://zoo-project.org>`__. It allows to execute the `OTB Applications <http://orfeo-toolbox.org/otb/otb-applications.html>`_ directly as ZOO WPS Services thanks to a :ref:`kernel_index` specific internal mechanism which is detailed in this section.
     7The optional Orfeo Toolbox support is available since `ZOO-Project 1.5 <http://zoo-project.org>`__. It allows to execute the `OTB Applications <http://orfeo-toolbox.org/otb/otb-applications.html>`_ directly as ZOO WPS Services thanks to a :ref:`kernel_index` specific internal mechanism which is detailed in this section.
    98
    109.. note::
    … …  
    2322------------------------------
    2423
    25 Follow the step described bellow in order to activate the ZOO-Project
    26 optional Orfeo Toolbox support.
     24Follow the step described bellow in order to activate the ZOO-Project optional Orfeo Toolbox support.
    2725
    2826Prerequisites
    29 .............
     27.....................
    3028
    3129   * latest `ZOO-Kernel <http://zoo-project.org/trac/browser/trunk/zoo-project/zoo-kernel>`_ trunk version
    32    * Orfeo Toolbox (`OTB 4.2.1 <http://orfeo-toolbox.org/otb/>`_ )
    33    * Insight Segmentation and Registration Toolkit  (`ITK-4.7 <http://itk.org/ITK/resources/software.html/>`_ )
     30   * Orfeo Toolbox (`OTB 4.2.1 <http://orfeo-toolbox.org/otb/>`_)
     31   * Insight Segmentation and Registration Toolkit  (`ITK-4.7 <http://itk.org/ITK/resources/software.html/>`_)
    3432
    3533Installation steps
    … …  
    5755
    5856Configuration steps
    59 *************************
     57....................................
    6058
    6159Main configuration file
    62 ^^^^^^^^^^^^^^^^^^^^^^^
     60*************************
    6361
    6462Add the following content to your ``/usr/lib/cgi-bin/main.cfg`` file
    … …  
    7068
    7169Services configuration file
    72 ^^^^^^^^^^^^^^^^^^^^^^^^^^
     70****************************
    7371
    7472The build of the `otb2zcfg  <http://zoo-project.org/trac/browser/trunk/thirds/otb2zcfg>`_ utility is required to activate the available OTB Applications as WPS services. This can be done using the following command:
    … …  
    9694     The ITK_AUTOLOAD_PATH environment variable is required in the [env] section of your main.cfg.
    9795
    98 Test the ZOO OTB support
    99 ^^^^^^^^^^^^^^^^^^^^^^^
     96Test requests
     97****************************
    10098
    10199Once done, OTB Applications should be listed as available WPS Services when runing a GetCapabilities request
    … …  
    111109   http://localhost/cgi-bin/zoo_loader.cgi?request=DescribeProcess&service=WPS&version=1.0.0&Identifier=OTB.BandMath
    112110
    113 As an example, here is a test request executing the OTB.BandMath Application with the OTB Cookbook sample data as input
     111Here is an example request executing the *OTB.BandMath* Application with the `OTB Cookbook <https://www.orfeo-toolbox.org/CookBook/CookBook.html>`_ sample data as input
    114112
    115113.. code-block:: guess
    … …  
    119117
    120118.. note::
    121    When executing OTB applications as WPS Services, it is also possible to check the OTB process status, using the usual ZOO GetStatus request.
     119
     120   The usual ZOO GetStatus requests also work when using the OTB Applications as WPS Services.
    122121
    123122

  • branches/PublicaMundi_David-devel/docs/kernel/sagagis.rst

    r659 r663  
    1818
    1919
    20 How does it work ?
    21 -------------------------
    22 
    23 
    24 
    2520Installation and configuration
    2621------------------------------
    … …  
    2924
    3025Prerequisites
    31 .............
     26.....................
    3227
    3328   * latest `ZOO-Kernel <http://zoo-project.org/trac/browser/trunk/zoo-project/zoo-kernel>`_ trunk version
    … …  
    6257
    6358Configuration steps
    64 *************************
     59...............................
    6560
    66 Main configuration file
    67 ^^^^^^^^^^^^^^^^^^^^^^^
     61Services configuration file
     62****************************
    6863
    69 Add the following content to your ``/usr/lib/cgi-bin/main.cfg`` file
    70 in the ``[env]`` section:
     64Building the `saga2zcfg
     65<http://zoo-project.org/trac/browser/trunk/thirds/otb2zcfg >`_ utility is required to activate the available SAGA-GIS Modules as WPS Services. This can be done using the following command:
    7166
    7267.. code-block:: guess
    7368
    74        ITK_AUTOLOAD_PATH=/usr/local/lib/otb/applications
     69    cd thirds/saga2zcfg
     70    make
    7571
    76 Services configuration file
    77 ^^^^^^^^^^^^^^^^^^^^^^^^^^
    78 
    79 The build of the `otb2zcfg  <http://zoo-project.org/trac/browser/trunk/thirds/otb2zcfg>`_ utility is required to activate the available OTB Applications as WPS services. This can be done using the following command:
     72The following commands will then generate all the needed zcfg files for the available SAGA-GIS Modules:
    8073
    8174.. code-block:: guess
    82        
    83          mkdir build
    84          cd build
    85          ccmake ..
    86          make
    87        
    88 Run the following command to generate all the needed zcfg files for the available OTB Application:
    89 
    90 .. code-block:: guess
    91        
    92          mkdir zcfgs
    93          cd zcfgs
    94          export ITK_AUTOLOAD_PATH=/your/path/to/otb/applications
    95          ../build/otb2zcfg
    96          mkdir /location/to/your/cgi-bin/OTB
    97          cp *zcfg /location/to/your/cgi-bin/OTB
    98        
    99 .. warning
    100 
    101      The ITK_AUTOLOAD_PATH environment variable is required in the [env] section of your main.cfg.
    102 
    103 Test the ZOO SAGA support
    104 ^^^^^^^^^^^^^^^^^^^^^^^
    105 
    106 Once done, OTB Applications should be listed as available WPS Services when runing a GetCapabilities request
    107 
    108 .. code-block:: guess
    109 
    110         http://localhost/cgi-bin/zoo_loader.cgi?request=GetCapabilities&service=WPS
    111 
    112 Each OTB Service can then be described individually using the DescribeProcess request, as for example:
    113 
    114 .. code-block:: guess
    115 
    116    http://localhost/cgi-bin/zoo_loader.cgi?request=DescribeProcess&service=WPS&version=1.0.0&Identifier=OTB.BandMath
    117 
    118 And executed according to your needs, as for the following example executing OTB.BandMath with the OTB sample data as input
    119 
    120 .. code-block:: guess
    121 
    122    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
    123 
    124 When executing OTB applications as WPS Services, it is also possible to check the OTB process status, using the usual ZOO GetStatus request.
     75               
     76    mkdir zcfgs
     77    cd zcfgs
     78    ../saga2zcfg
     79    mkdir /location/to/your/cgi-bin/SAGA
     80    cp *zcfg /location/to/your/cgi-bin/SAGA
    12581
    12682
     83Test requests
     84*****************
    12785
    128    
     86The SAGA-GIS Modules should be listed as available WPS Services when
     87runing a GetCapabilities request, as follow:
     88
     89http://localhost/cgi-bin/zoo_loader.cgi?request=GetCapabilities&service=WPS
     90
     91Each SAGA-GIS Service can then be described individually using the DescribeProcess request, as for example:
     92
     93http://localhost/cgi-bin/zoo_loader.cgi?request=DescribeProcess&service=WPS&version=1.0.0&Identifier=SAGA.garden_fractals.1
     94
     95And executed according to your needs. The following example executes *SAGA.garden_fractals.1* with no optional parameter:
     96
     97http://localhost/cgi-bin/zoo_loader.cgi?request=Execute&service=WPS&version=1.0.0&Identifier=SAGA.garden_fractals.1&DataInputs=&ResponseDocument=RESULT@mimeType=application/json@asReference=true
     98
     99.. note::
     100   
     101  The common ZOO GetStatus requests also work when using the SAGA-GIS Modules as WPS Services.
    129102
    130103
    131104
    132105
    133 
    134 

  • branches/PublicaMundi_David-devel/docs/kernel/what.rst

    r659 r663  
    1919-----------------------
    2020
    21 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 <http://httpd.apache.org/>`_ or `IIS <http://www.iis.net/>`_ |trade|) and can be seamlessly integrated to new or existing web platforms.
     21ZOO-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 is a CGI program which works on common web servers (namely `Apache <http://httpd.apache.org/>`_ or `IIS <http://www.iis.net/>`_ |trade|). It can be seamlessly integrated to new or existing web platforms.
    2222
    2323ZOO-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. 
    2424
    2525Supported programming languages
    26 ...............................
     26........................................................
    2727
    2828ZOO-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.
Note: See TracChangeset for help on using the changeset viewer.

Download now !

Search

Context Navigation

Main Navigation

ZOO Sponsors

http://www.zoo-project.org/trac/chrome/site/img/geolabs-logo.pnghttp://www.zoo-project.org/trac/chrome/site/img/neogeo-logo.png http://www.zoo-project.org/trac/chrome/site/img/apptech-logo.png http://www.zoo-project.org/trac/chrome/site/img/3liz-logo.png http://www.zoo-project.org/trac/chrome/site/img/gateway-logo.png

Become a sponsor !

Knowledge partners

http://www.zoo-project.org/trac/chrome/site/img/ocu-logo.png http://www.zoo-project.org/trac/chrome/site/img/gucas-logo.png http://www.zoo-project.org/trac/chrome/site/img/polimi-logo.png http://www.zoo-project.org/trac/chrome/site/img/fem-logo.png http://www.zoo-project.org/trac/chrome/site/img/supsi-logo.png http://www.zoo-project.org/trac/chrome/site/img/cumtb-logo.png

Become a knowledge partner

Related links

http://zoo-project.org/img/ogclogo.png http://zoo-project.org/img/osgeologo.png