##########
User Guide
##########

.. contents::
   :depth: 2
   :local:

************
DAP Requests
************

.. _what-is-dap-p:

What is DAP ?
=================

The Data Access Protocol.

http://opendap.org/

http://opendap.org/faq/whatIsDods.html

Examples
========

URL : `http://ctoh.legos.obs-mip.fr/ctoh.nc?time,lon,lat,lambda&ctoh_mission=filaments&lon>40&lon<50&lat>-10&lat<5` (`DAP Example 1`_)

.. _DAP Example 1: http://ctoh.legos.obs-mip.fr/ctoh.nc?time,lon,lat,lambda&ctoh_mission=filaments&lon>40&lon<50&lat>-10&lat<5

.. _ctoh-database-available-label:

***************************
Databases available at CTOH
***************************

CTOH databases
==============

.. index::
   pair: ctoh_mission; parameters

The following :term:`ctoh_mission` are defined:

 * ``jason2``
 * ``filaments``
 * ``gfo``
 * ``envisat``

.. _ctoh-parameters-reference-label:

CTOH Parameters reference
=========================

CTOH distributes original gdr, together with home-brewed parameters.

.. warning::
   This section should be generated out of formal (XML) definitions of databases

Globals
-------

These parameters are defined as global variable :

.. index::
   pair: ctoh_mission; parameters

.. glossary::

   ``ctoh_mission``
        Database to consider. See :ref:`ctoh-database-available-label`.

.. index::
   pair: ctoh_dataset; parameters

.. glossary::

   ``ctoh_dataset``
        Original dataset file name.

.. index::
   pair: ctoh_cycle_number; parameters

.. glossary::

   ``ctoh_cycle_number``
        Dataset cycle number.

.. index::
   pair: ctoh_pass_number; parameters

.. glossary::

   ``ctoh_pass_number``
        Dataset pass number, a.k.a. trace number.

.. index::
   pair: ctoh_dataset_size; parameters

.. glossary::

   ``ctoh_dataset_size``
        Original dataset file size.

.. index::
   pair: ctoh_dataset_ctime; parameters

.. glossary::

   ``ctoh_dataset_ctime``
        Original dataset file create date.

Envisat
-------

Envisat specific global variables
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Envisat specific variables
^^^^^^^^^^^^^^^^^^^^^^^^^^

.. index::
   pair: uso_range_corr; parameters

.. glossary::

   ``uso_range_corr``
        USO range correction.

.. index::
   pair: time_hf; parameters

.. glossary::

   ``time_hf``
        High Frequency time scale.


GFO
---

GFO specific global variables
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

GFO specific variables
^^^^^^^^^^^^^^^^^^^^^^

.. index::
   pair: time_hf; parameters

.. glossary::

   ``time_hf``
	High Frequency time scale.

Jason2
-------

Jason2 specific global variables
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Jason2 specific variables
^^^^^^^^^^^^^^^^^^^^^^^^^

.. index::
   pair: time_hf; parameters

.. glossary::

   ``time_hf``
        High Frequency time scale, formerly known as ``time_20hz``.

Jason1c
-------

Jason1c specific global variables
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Jason1c specific variables
^^^^^^^^^^^^^^^^^^^^^^^^^^