Changes between Version 64 and Version 65 of Documentation


Ignore:
Timestamp:
Nov 17, 2017, 2:24:00 PM (8 years ago)
Author:
Peter Baumann
Comment:

—

Legend:

Unmodified
Added
Removed
Modified

  • Documentation

    v64 v65  
    66We believe that good documentation is probably the single most important thing for a successful project. We work hard on high quality documentation - you can help us by letting us know about areas that are unclear, helpful additions, etc.
    77
    8 Note: if you are interested in geo data management specifically, you want to look at installatoin and then [here].
     8''Note: if you are interested in geo data management specifically, you want to look at installation and then jump [here].''
    99
    1010== Installation and Administration ==
    1111* [wiki:Download Downloading rasdaman]
    1212* [source:manuals_and_examples/manuals/doc-guides/inst-guide.pdf Installation and Administration Guide] (as of 9.2, still slightly behind - best use the wiki page mentioned above)
    13  * Only if you want to use PostgreSQLas pixel store, not rasdaman's native storage manager: [source:manuals_and_examples/manuals/doc-guides/external-guide-POSTGRESQL.pdf PostgreSQL connector] and [wiki:Performance Performance and various PostgreSQL bits and pieces]
     13 * Only if you want to use PostgreSQL as pixel store, rather than rasdaman's native storage manager: [source:manuals_and_examples/manuals/doc-guides/external-guide-POSTGRESQL.pdf PostgreSQL connector] and [wiki:Performance Performance and various PostgreSQL bits and pieces]
    1414* [wiki:Configuration configuration files & directories overview]
     15* Local Installation Documentation: Open `$RMANHOME/share/rasdaman/doc/index.html` in a Web browser, assuming `$RMANHOME` as installation directory. In addition to the documents referenced on this wiki page this local documentation set contains a browseable HTML documentation of the APIs, plus programming and query examples.
    1516
    16 == Local Installation Documentation ==
    17 * Open `$RMANHOME/share/rasdaman/doc/index.html` in a Web browser.
     17== Array Query Programming ==
     18If you want to work directly with the rasdaman array query language, rasql, you find ample documentation and examples. Specifically for geo data management, however, your preferred API will be the OGC standards conformant Web service described [below].
    1819
    19 == Online User Guide ==
    20   * [source:manuals_and_examples/manuals/doc-guides/ql-guide.pdf Query Language Guide for rasql]; query examples therein rely on the demo data, delivered with rasdaman, which can be inserted through `rasdaman_insertdemo.sh`. Hence, all examples can be readily run.
    21    * [wiki:PartialUpdates Partial updates explained] (or how to insert large amounts of data in rasdaman)
    22    * [wiki:Tiling Tiling guide]
    23   * [source:manuals_and_examples/manuals/doc-guides/rview-guide.pdf Rview Guide] to the graphical interactive query frontend
    24   * [wiki:PetascopeUserGuide Latest User Guide for petascope] (previous: [wiki:PetascopeUserGuide_8_5 v8.x]) + [wiki:PetascopeDevGuide Developers Guide]
    25   * [wiki:SecoreUserGuide User Guide for SECORE] + [wiki:SecoreDevGuide Developers Guide]
    26   * [wiki:raswct/guide raswct guide] for the `Rasdaman Web Client Toolkit`
    27   * [wiki:RRasdamanTutorial RRasdaman Tutorial] for R package for rasdaman.
    28   * [wiki:WCSTGuide WCS-T] + [wiki:WCSTImportGuide WCS-T ingestion tool guide] for petascope
    29 * API documentation:
    30   * [source:manuals_and_examples/manuals/doc-guides/dev-guide-c++.pdf C++ Development Guide]
    31   * [source:manuals_and_examples/manuals/doc-guides/dev-guide-java.pdf Java Development Guide]
    32   * [source:manuals_and_examples/manuals/doc-guides/dev-guide-raswct.pdf Rasdaman Web Client Toolkit]
    33   * [wiki:DebuggingBenchmarking Debugging and Benchmarking Support]
    34 * Testing
    35   * Automated tests with [wiki:RasdamanTestSuites systemtests]
    36 * Tutorials
    37   * [Workshops/BigDataRasdamanApproach Spatio-Temporal Big Data: the rasdaman approach]
     20* [source:manuals_and_examples/manuals/doc-guides/ql-guide.pdf Query Language Guide for rasql]; query examples therein rely on the demo data, delivered with rasdaman, which can be inserted through `rasdaman_insertdemo.sh`. Hence, all examples can be readily run.
     21 * [wiki:PartialUpdates Partial updates explained] (or how to insert large amounts of data in rasdaman)
     22* [source:manuals_and_examples/manuals/doc-guides/dev-guide-c++.pdf C++ Development Guide]
     23* [source:manuals_and_examples/manuals/doc-guides/dev-guide-java.pdf Java Development Guide]
    3824
    39 If you have installed rasdaman in `$RMANHOME` then you will find the '''complete documentation''' installed, too; direct your browser to
    40 {{{
    41 $RMANHOME/share/rasdaman/doc/index.html
    42 }}}
    43 In addition to the documents replicated here it contains a browseable HTML documentation of the APIs, plus programming and query examples.
     25== Tuning Guide ==
     26* [wiki:Tiling Tiling guide]
    4427
    45 == Versions ==
     28* [wiki:raswct/guide raswct guide] for the `Rasdaman Web Client Toolkit`
    4629
    47 The [wiki:Versions Versions page] lists changes made between successive versions released.
    4830
     31== Versions and Testing ==
     32
     33* The [wiki:Versions Versions page] lists changes made between successive versions released.
     34* Automated tests are available with the [wiki:RasdamanTestSuites rasdaman system tests].
     35* [wiki:DebuggingBenchmarking Debugging and Benchmarking Support]
     36
     37== Data Analytics ==
     38* [wiki:RRasdamanTutorial RRasdaman Tutorial] for R package for rasdaman
     39* python: tbd
     40* [source:manuals_and_examples/manuals/doc-guides/dev-guide-raswct.pdf Rasdaman Web Client Toolkit]
     41
     42== Geo Data Management ==
     43In order to use rasdaman for geo raster management - in particular: spatio-temporal geo datacubes - consult these documentation pages:
     44
     45* general overview and tutorial: [Workshops/BigDataRasdamanApproach Spatio-Temporal Big Data: the rasdaman approach]
     46* [wiki:PetascopeUserGuide User Guide] and [wiki:PetascopeDevGuide Developer Guide] to rasdaman's geo service interface, petascope
     47* data import [wiki:WCSTGuide WCS-T] + [wiki:WCSTImportGuide WCS-T ingestion tool guide] for petascope
     48* [wiki:SecoreUserGuide User Guide for SECORE] + [wiki:SecoreDevGuide Developers Guide]
     49