[[TracNav(TOC)]]
[[PageOutline]]

= Rasdaman Documentation =

We 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.

''Note: if you are interested in geo data management specifically, you want to look at installation and then jump [wiki:Documentation#GeoDataManagement here].''

== Installation and Administration ==
In the sequel we refer to `$RMANHOME` as the rasdaman installation directory. When compiling from source, it is` /opt/rasdaman`by default; RPM installations keep with Linux conventions when placing directories, ee the package manager's listing.

* [wiki:Download Downloading rasdaman]
* [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)
 * 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]
* [wiki:Configuration configuration files & directories overview]
* 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.

== Array Query Programming ==
If 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 [wiki:Documentation#GeoDataManagement below].

* [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.
 * [wiki:PartialUpdates Partial updates explained] (or how to insert large amounts of data in rasdaman)
* [source:manuals_and_examples/manuals/doc-guides/dev-guide-c++.pdf C++ Development Guide]
* [source:manuals_and_examples/manuals/doc-guides/dev-guide-java.pdf Java Development Guide]

== Tuning Guide ==
* [wiki:Tiling Tiling guide]



== Versions and Testing ==

* The [wiki:Versions Versions page] lists changes made between successive versions released.
* Automated tests are available with the [wiki:RasdamanTestSuites rasdaman system tests].
* [wiki:DebuggingBenchmarking Debugging and Benchmarking Support]

== Data Analytics ==
* [wiki:RRasdamanTutorial RRasdaman Tutorial] for R package for rasdaman
* python: tbd
* rasdaman Web Client Toolkit, raswct: [wiki:raswct/guide wiki guide] and [source:manuals_and_examples/manuals/doc-guides/dev-guide-raswct.pdf manual]

== Geo Data Management ==
In order to use rasdaman for geo raster management - in particular: spatio-temporal geo datacubes - consult these documentation pages:

* general overview and tutorial: [Workshops/BigDataRasdamanApproach Spatio-Temporal Big Data: the rasdaman approach]
* [wiki:PetascopeUserGuide User Guide] and [wiki:PetascopeDevGuide Developer Guide] to rasdaman's geo service interface, petascope
* data import [wiki:WCSTGuide WCS-T] + [wiki:WCSTImportGuide WCS-T ingestion tool guide] for petascope
* [wiki:SecoreUserGuide User Guide for SECORE] + [wiki:SecoreDevGuide Developers Guide]