Commit a6079c29 authored by Peters, Wouter's avatar Peters, Wouter
Browse files

Start of documentation for system, in sphinx

parent c0f002d5
# Makefile for Sphinx documentation
# You can set these variables from the command line.
SPHINXBUILD = sphinx-build-2.6
BUILDDIR = build
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
-rm -rf $(BUILDDIR)/*
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
@echo "Build finished; now you can process the pickle files."
@echo "Build finished; now you can process the JSON files."
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/CarbonTrackerDataAssimilationShell.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/CarbonTrackerDataAssimilationShell.qhc"
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/CarbonTrackerDataAssimilationShell"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/CarbonTrackerDataAssimilationShell"
@echo "# devhelp"
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
@echo "Running LaTeX files through pdflatex..."
make -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
@echo "Build finished. The text files are in $(BUILDDIR)/text."
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
@echo "The overview file is in $(BUILDDIR)/changes."
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 29c2fd345d748612ee705cfd9e89ed06
tags: fbb0d17656682115ca4d033fb2f83ba1
.. _contents:
.. toctree::
:maxdepth: 2
System Requirements <systemrequirements>
Installing CTDAS <installing>
CTDAS Overview <overview>
CTDAS Tutorial <tutorial>
CTDAS Documentation <documentation>
.. _documentation:
.. _gettingstarted:
Getting Started with CTDAS
.. automodule:: da.ct.obs
:members: CtObservations
.. CarbonTracker Data Assimilation Shell documentation master file, created by
sphinx-quickstart on Sun Sep 26 13:39:23 2010.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to the CTDAS documentation!
This is the starting page for the documentation of the CarbonTracker Data Assimilation Shell (CTDAS).
.. sidebar:: What is CTDAS?
CTDAS is short for "CarbonTracker Data Assimilation Shell".
This is the implementation of an extendible data assimilation framework for CarbonTracker,
developed by NOAA ESRL & Wageningen University, in close cooperation with many partners around the world.
The aim of the CTDAS system is to facilitate the use of CarbonTracker, and to
foster its development by its many international partners. At its most basic, the CTDAS is a simple
control system for CarbonTracker that deals with the running, optimization, analysis, and time stepping of the system.
For advanced users, the CTDAS provides an easy way to extend or modify the system by introducing new configurations
for the state vector, for the observations, or even for the transport model or optimization method.
The CarbonTracker development team welcomes suggestions and feedback on the CTDAS system, and its documentation.
Follow the link below to start navigating, or use the "next topic" button in the right-hand-side menu.
.. toctree::
:maxdepth: 1
List of contents <contents>
.. _overview:
.. index:: overview, philosophy, development centers
This page gives a brief overview of CTDAS, with the intention to provide background information for (potential) new users. Afer reading the information below we recommend contacting one of the CTDAS development centers (Wageningen University and NOAA ESRL), or proceed to the :doc:`tutorial`.
What is CTDAS?
How can you use CTDAS?
CTDAS Design philosophy
Extending CTDAS
.. _systemrequirements:
System Requirements
The CarbonTracker DAS is programmed in python and uses it built-in functionality for many of its tasks.
Users of CTDAS are required to have a python installation on their system, with a small set of
open source add-ons. The minimum requirements are listed below, categorized by functionality.
Getting the CTDAS code
* A working ``subversion`` (SVN) installation is needed, to check your system type::
$ svn --version
if the system returns an error, or a version < 1.5.0, please obtain svn from <>
Running CTDAS
* A ``python2.4`` or later installation.
.. note:: ``python3`` is not supported, one needs a python2.x version. To check your python version type::
$ python --version
* The python module ``numpy``, not included with a standard installation. You can obtain numpy from <>
* The python module ``Nio`` created by NCAR/UCAR. This package is freely available as a binary download from UCAR's Earth System Grid at <>
.. note:: Registration is required at NCAR/UCAR, their software is free for academic users.
Performing inversions
* An important component of the CTDAS system is the observation operator, usually in the form of an atmospheric
transport model. This model is a stand-alone piece of code that can subsample your state vector, and return a
set of observations. **You therefore require an atmospheric transport model that can run indepently on your
.. note:: If you do not currently have access to such a transport model, or have no resources to run such a model
for long periods of time and for many ensemble configurations, you have probably stumbled onto this page not
understanding exactly what CTDAS is. We refer you to the :ref:`overview` for a more elaborate description.
* An actual CarbonTracker inversion requires a large collection of input datasets, including
* Observations to be assimilated
* a-priori surface fluxes for your trace components
* a-priori uncertainty distributions for your unknowns
* ... and a few more items
.. _tutorial:
* basic.css
* ~~~~~~~~~
* Sphinx stylesheet -- basic theme.
* :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
/* -- main layout ----------------------------------------------------------- */
div.clearer {
clear: both;
/* -- relbar ---------------------------------------------------------------- */
div.related {
width: 100%;
font-size: 90%;
div.related h3 {
display: none;
div.related ul {
margin: 0;
padding: 0 0 0 10px;
list-style: none;
div.related li {
display: inline;
div.related li.right {
float: right;
margin-right: 5px;
/* -- sidebar --------------------------------------------------------------- */
div.sphinxsidebarwrapper {
padding: 10px 5px 0 10px;
div.sphinxsidebar {
float: left;
width: 230px;
margin-left: -100%;
font-size: 90%;
div.sphinxsidebar ul {
list-style: none;
div.sphinxsidebar ul ul,
div.sphinxsidebar ul.want-points {
margin-left: 20px;
list-style: square;
div.sphinxsidebar ul ul {
margin-top: 0;
margin-bottom: 0;
div.sphinxsidebar form {
margin-top: 10px;
div.sphinxsidebar input {
border: 1px solid #98dbcc;
font-family: sans-serif;
font-size: 1em;
img {
border: 0;
/* -- search page ----------------------------------------------------------- */ {
margin: 10px 0 0 20px;
padding: 0;
} li {
padding: 5px 0 5px 20px;
background-image: url(file.png);
background-repeat: no-repeat;
background-position: 0 7px;
} li a {
font-weight: bold;
} li div.context {
color: #888;
margin: 2px 0 0 30px;
text-align: left;
ul.keywordmatches li.goodmatch a {
font-weight: bold;
/* -- index page ------------------------------------------------------------ */
table.contentstable {
width: 90%;
table.contentstable p.biglink {
line-height: 150%;
a.biglink {
font-size: 1.3em;
span.linkdescr {
font-style: italic;
padding-top: 5px;
font-size: 90%;
/* -- general index --------------------------------------------------------- */
table.indextable {
width: 100%;
table.indextable td {
text-align: left;
vertical-align: top;
table.indextable dl, table.indextable dd {
margin-top: 0;
margin-bottom: 0;
table.indextable tr.pcap {
height: 10px;
table.indextable tr.cap {
margin-top: 10px;
background-color: #f2f2f2;
img.toggler {
margin-right: 3px;
margin-top: 3px;
cursor: pointer;
div.modindex-jumpbox {
border-top: 1px solid #ddd;
border-bottom: 1px solid #ddd;
margin: 1em 0 1em 0;
padding: 0.4em;
div.genindex-jumpbox {
border-top: 1px solid #ddd;
border-bottom: 1px solid #ddd;
margin: 1em 0 1em 0;
padding: 0.4em;
/* -- general body styles --------------------------------------------------- */
a.headerlink {
visibility: hidden;
h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
h4:hover > a.headerlink,
h5:hover > a.headerlink,
h6:hover > a.headerlink,
dt:hover > a.headerlink {
visibility: visible;
div.body p.caption {
text-align: inherit;
div.body td {
text-align: left;
.field-list ul {
padding-left: 1em;
.first {
margin-top: 0 !important;
p.rubric {
margin-top: 30px;
font-weight: bold;
.align-left {
text-align: left;
.align-center {
clear: both;
text-align: center;
.align-right {
text-align: right;
/* -- sidebars -------------------------------------------------------------- */
div.sidebar {
margin: 0 0 0.5em 1em;
border: 1px solid #ddb;
padding: 7px 7px 0 7px;
background-color: #ffe;
width: 40%;
float: right;
p.sidebar-title {
font-weight: bold;
/* -- topics ---------------------------------------------------------------- */
div.topic {
border: 1px solid #ccc;
padding: 7px 7px 0 7px;
margin: 10px 0 10px 0;
p.topic-title {
font-size: 1.1em;
font-weight: bold;
margin-top: 10px;
/* -- admonitions ----------------------------------------------------------- */
div.admonition {
margin-top: 10px;
margin-bottom: 10px;
padding: 7px;
div.admonition dt {
font-weight: bold;
div.admonition dl {
margin-bottom: 0;
p.admonition-title {
margin: 0px 10px 5px 0px;
font-weight: bold;
div.body p.centered {
text-align: center;
margin-top: 25px;
/* -- tables ---------------------------------------------------------------- */
table.docutils {
border: 0;
border-collapse: collapse;
table.docutils td, table.docutils th {
padding: 1px 8px 1px 5px;
border-top: 0;
border-left: 0;
border-right: 0;
border-bottom: 1px solid #aaa;
table.field-list td, table.field-list th {
border: 0 !important;
table.footnote td, table.footnote th {
border: 0 !important;
th {
text-align: left;
padding-right: 5px;
table.citation {
border-left: solid 1px gray;
margin-left: 1px;
table.citation td {
border-bottom: none;
/* -- other body styles ----------------------------------------------------- */
ol.arabic {
list-style: decimal;
ol.loweralpha {
list-style: lower-alpha;