.. cf-python documentation master file, created by
   sphinx-quickstart on Wed Aug  3 16:28:25 2011.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

cf-python |release| documentation
=================================

`CF
<http://cf-pcmdi.llnl.gov/documents/cf-conventions/1.6/cf-conventions.html>`_
is a `netCDF <http://www.unidata.ucar.edu/software/netcdf>`_
convention which is in wide and growing use for the storage of
model-generated and observational data relating to the atmosphere,
ocean and Earth system.

This package is an implementation of the `CF data model
<https://cf-pcmdi.llnl.gov/trac/ticket/68>`_, and as such it is an API
allows for the full scope of data and metadata interactions described
by the CF conventions.

With this package you can:

    * Read CF-netCDF and `PP
      <http://badc.nerc.ac.uk/help/formats/pp-format/>`_ format files,
      aggregating their contents into as few multidimensional fields
      as possible.

    * Write fields to CF-netCDF files on disk.

    * Create, delete and modify a field's data and metadata.

    * Select fields by their metadata values.

    * Subset a field's data to create a new field.

    * Perform arithmetic and comparison operations with fields.

All of the above use :ref:`LAMA` functionality, which allows multiple
fields larger than the available memory to exist and be
manipulated.

See the `cf-python home page <http://code.google.com/p/cf-python/>`_
for downloads, installation and source code.

----

.. toctree::
   :maxdepth: 2

   getting_started

.. toctree::
   :maxdepth: 2

   reference 

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`