Project

General

Profile

CAMS CH4 demo

At the TM5 meeting of 2018-06 it was deceided to make demonstration versions out of the various TM5/4D-Var currently present.
This page will describe how to obtain a working version of a CH4 inversion code, based on the CAMS/CH4 flux inversions, and using TM5-MP.

Note that the system is not completed yet, the demo is now only used to test the first steps ...

Checkout source code

The CAMS-CH4 inversion code is managed as a branch on the svn server.
The standard configuration assumes that files are on a path relative to your home directory;
use the following steps to checkout the codes at the assumed location:

# goto home directory:
cd ~

# create target directory:
mkdir -p TM5-4DVAR/branches

# change into it:
cd TM5-4DVAR/branches

# checkout the "cams-ch4" branch from the repository:
svn checkout https://svn.knmi.nl/svn/TM5-4DVAR/branches/cams-ch4

Also checkout a TM5-MP version:

# goto home directory:
cd ~

# create target directory:
mkdir -p TM5-MP/branches

# change into it:
cd TM5-MP/branches

# checkout the "adjoint2" branch from the repository:
svn checkout https://svn.knmi.nl/svn/TM5-MP/branches/adjoint2

If necessary, checkout the codes at another location and create links in the home directory.
When familiar with the configuration files, the actual paths could also be defined in the (machine specific) settings.

Data package

A data package has been created that allows running a demo inversion over 1 month.
If you have access to the TM5 SourceForge site, copy the data package from the Files tab of this website:

TM5-SF-data__v2020-10.tar.gz

Alternatively, if you have access to the SARA/Cartesius plaform, copy the data package from:

/projects/0/tm54dvar/arjo/pub/TM5-SF-data__v2020-10.tar.gz

The standard configuration assumes that the data is unpacked into the home directory:

~/TM5-SF-data

On SARA/Cartesius, it is sufficient to create a link:

cd ~
ln -s /projects/0/tm54dvar/arjo/TM5-SF-data .

Documentation

The documentation of the inversion system is shipped with the code, but needs to be generated first:

cd ~/TM5-4DVAR/branches/cams-ch4
make docu

The documentation is build using Spinx, which is usually available from the Python distribution.

In case building the documentation fails, obtain a (probably outdated) copy from the Files tab of this site.

Browse through the documentation via:

doc/user-guide/build/html/index.html

Tutorial

The best way to start working with this inversion system is to use the Tutorial chapter in the documentation.