Commit 9923d657 authored by Jeff Piollé's avatar Jeff Piollé

updated doc

parent e888d7b4
......@@ -8,10 +8,30 @@ This page provides a summary of cerbere's API. For more details
and examples, refer to the relevant chapters in the main part of the
documentation.
See also: :ref:`public api`
Dataset
=======
Creating a dataset
------------------
.. autosummary::
:toctree:
:toctree: generated/
Dataset
Attributes
----------
.. autosummary::
:toctree: generated/
Dataset.dims
Dataset.sizes
Dataset.coords
Dataset.attrs
dataset
feature
Feature
=======
Built-in mappers
================
Datasets
========
**cerbere** mappers and data models have been tested with the following list of
products, ordered here by mapper:
products, ordered here by Dataset. To minimize the amount of modules or
dependencies to install, mappers are grouped by contrib packages, so that users
only need to install the contribs for the Dataset classes they need.
Built-in Dataset classes
------------------------
These are the Dataset classes provided with the base cerbere package.
.. csv-table:: **cerbere** package
:header: "Dataset", "Compatible products"
:widths: 15, 40
"NCDataset", "Most CF compliant netCDF dataset (if correctly complying!)"
, "CATDS SMOS SSS CEC-OS products"
, "AVISO L2 (S)GDR"
, "Ifremer (Boyer) Mixed Layer Depth climatology"
"GHRSSTNCDataset", "GHRSST L2P, L3 and L4 datasets"
Contribs
--------
These are the contrib packages providing additional more specialized Dataset
classes, grouped by thematic, data provider, format family,...
.. csv-table:: **cerberecontrib-s3** package
:header: "Dataset", "Compatible products"
:widths: 15, 40
"Dataset", "Product"
.. csv-table:: **cerberecontrib-cfosat** package
:header: "Dataset", "Compatible products"
:widths: 15, 40
"Dataset", "Product"
.. csv-table:: **cerberecontrib-scatterometer** package
:header: "Dataset", "Compatible products"
:widths: 15, 40
"Dataset", "Product"
NCDataset
---------
......
......@@ -4,17 +4,17 @@ Welcome to cerbere documentation!
This is the home of **cerbere** package. The objective of **cerbere** is to
provide different free and open source python modules for the reading,
interpretation, and writing of (primarily ocean) geophysical data.
interpretation, and writing of (ocean by designer's tropism but any other) earth observation data.
It is now based on **xarray** but extends it to read more data formats and adds
a typology of observation objects (or features).
a typology of observation objects (called **features**).
Contents
========
.. toctree::
:maxdepth: 2
:maxdepth: 1
installation
working_with_data
......
====================
Cerbere installation
====================
============
Installation
============
Requirements
......
==================
General principles
==================
========
Overview
========
Concept
=======
......@@ -12,7 +12,7 @@ types of observation features.
Many of these aspects are now handled by other packages, such as **xarray**.
**cerbere** leverages on xarray for internal data structure but goes further
in terms of normalization of feature description and metadata , following
in terms of normalization of feature description and metadata, following
standards such as CF convention and other community efforts, and adding a true
typology of common observation patterns. This is required to implement generic
software, truly independent from the choices of the various data producers.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment