.. _documentation:

Documentation
======================

Documentation exists for both the baseclasses that form the basic building blocks of CTDAS 
(also see ), and for the specific implementation of these for the CarbonTracker CO2 system. 
The specific classes *always* inherit from the baseclasses. 

Baseclasses
-----------

.. toctree::
   :maxdepth: 2
   
   The CycleControl Object <cyclecontrol>
   The DASystem Object <dasystem>
   The PlatForm Object <platform>
   The Observations Object <observations>
   The ObservationOperator Object <observationoperator>
   The StateVector and EnsembleMember Objects <statevector>
   The Optimizer Object <optimizer>

Platform classes 
----------------

.. toctree::
   :maxdepth: 2

   The maunaloa platform (MacOSX at Wageningen University) <maunaloa>
   The jet platform (Linux system at NOAA ESRL)  <jet>

Pipelines
---------

.. toctree::
   :maxdepth: 2

   Inverse pipeline <pipeline>


CarbonTracker CO2 classes
-------------------------

.. toctree::
   :maxdepth: 2
   
   The CtObservations Object <ctobservations>
   The TM5ObservationOperator Object <tm5observationoperator>
   The CtStateVector and EnsembleMember Objects <ctstatevector>
   The CtOptimizer Object <ctoptimizer>

The Analysis Suite 
------------------

.. toctree::
   :maxdepth: 2