TSMP-PDAF Documentation

TSMP-PDAF describes the build commands of TSMP that can introduce data assimilation for an ensemble of TSMP simulations using the Parallel Data Assimilation Framework (PDAF).

The User’s Guide is directed at end users who want to build TSMP-PDAF and run simulations.

The Developer’s Guide is directed at developers who contribute to or maintain TSMP-PDAF — including interface development, upstream PDAF merges, build-system configuration, and debugging of TSMP-PDAF.

The Reference section lists links to additional resources important for TSMP-PDAF, as well as source code browsers for the TSMP-PDAF interface and the PDAF library.

User's Guide

• Building TSMP-PDAF
• Running TSMP-PDAF
• Misc

Developer's Guide

• Contributing to TSMP-PDAF
• Developer information
• Debugging TSMP-PDAF
• TSMP-PDAF Preprocessor variables
• How to use this document

Reference

• PDAF documentation
• TSMP2 source code
• TSMP-PDAF Source Code Browser (library)
• TSMP-PDAF Source Code Browser (interface)

Issues

If you encounter errors or issues regarding TSMP-PDAF, please add them in one of the following places:

• TSMP-PDAF issues (related to source code) HPSCTerrSys/pdaf#issues

• Issues related to building TSMP-PDAF using TSMP2 HPSCTerrSys/TSMP2#issues

• TSMP-PDAF issues (internal) https://icg4geo.icg.kfa-juelich.de/ExternalRepos/tsmp-pdaf/tsmp-pdaf-issues

Citing TSMP-PDAF

Please cite the following when using TSMP-PDAF in a publication

• [KHK+16]

• [NH13]

About this documentation

The documentation for TSMP-PDAF is a living document, which means it will be continuously updated and improved. Please check back regularly for the latest information and updates.

This style of the TSMP-PDAF documentation is adapted from the eCLM-documentation: HPSCTerrSys/eCLM

References

[KHK+16]

Wolfgang Kurtz, Guowei He, Stefan J. Kollet, Reed M. Maxwell, Harry Vereecken, and Harrie-Jan Hendricks Franssen. Terrsysmp–pdaf (version 1.0): a modular high-performance data assimilation framework for an integrated land surface–subsurface model. Geoscientific Model Development, 9(4):1341–1360, Apr 2016. URL: http://dx.doi.org/10.5194/gmd-9-1341-2016, doi:10.5194/gmd-9-1341-2016.

[NH13]

Lars Nerger and Wolfgang Hiller. Software for ensemble-based data assimilation systems - Implementation strategies and scalability. Computers & Geosciences, 55:110–118, Jun 2013. URL: http://dx.doi.org/10.1016/j.cageo.2012.03.026, doi:10.1016/j.cageo.2012.03.026.