CableUserGuide_CABLE2_User_Guide

User Guide: CABLE-2.0

February 2013

Jhan Srbinovsky, Rachel Law, Bernard Pak

This document describes how to use the v2.0 release of the land surface model, CABLE. It is intended for both users and developers as a guide to getting started with CABLE. Two major changes are implemented with CABLE-2.0.

• CABLE-2.0 officially supports applications of the model in both a stand-alone (offline) capacity and also coupled to ACCESS (online).
• CABLE-2.0 is being released through a subversion repository hosted by the National Computational Infrastructure (NCI) so that future CABLE development can be more easily shared across the CABLE community.

This document should be read alongside other CABLE documentation, including:

• Technical description documents that outline the derivation and implementation of equations describing the physical processes that CABLE represents
  • Kowalczyk et al., 2006, http://www.cmar.csiro.au/e-print/open/kowalczykea_2006a.pdf
  • Raupach et al. 1997. Soil-Canopy-Atmosphere-Model description (predecessor to CABLE) attached below
  • Wang et al., 2010 describes CASA-CNP
  • Wang et al., 2011 describes CABLE in the appendix.
• Guidelines for the use and development of CABLE describes how CABLE is being managed, available at https://trac.nci.org.au/trac/cable/wiki/CableDocuments
• Coding standards describes the standards that CABLE code should aim to adhere to, available at https://trac.nci.org.au/trac/cable/wiki/CableDocuments.
• Basic benchmarking results from CABLE-2.0, available at https://trac.nci.org.au/trac/cable/wiki/CableBenchmarking.

Document history

26/11/12 Released online at https://trac.nci.org.au/trac/cable/wiki/CableDocuments

4/2/13 Removed references to CABLE sharepoint site (no longer supported), updated information on accessing code, added information on running MPI version (available from 39e0584109941fcf9fcadbc30747c623523c940e, CABLE trunk)

Contents

1. INTRODUCTION
2. GETTING CABLE
3. Using svn to download CABLE from the repository
4. CABLE-AUX
5. CABLE Tools
6. CABLE: offline
7. Building CABLE 1. [[build.ksh and Makefile_offline for serial version of CABLE|CableUserGuide_Offline]] 1. [[build_mpi.ksh and Makefile_mpi for parallel version of CABLE|CableUserGuide_Offline]]
8. Running CABLE 1. [[Executing cable*|CableUserGuide_Offline]] 1. [[run.ksh and multiple-sites|CableUserGuide_Offline]] 1. [[Single-site vs global grid|CableUserGuide_Offline]] 1. [[Executing cable-mpi*|CableUserGuide_Offline]]
9. CABLE: ACCESS/UM
10. Building CABLE for the UM
11. Building the UM with CABLE 1. The UMUI, $CABLE_AUX and .kshrc 1. Example UMUI Jobs
12. Running the UM with CABLE
13. CABLE output from ACCESS simulations
14. CABLE configuration
15. Input files 1. Namelist file 1. Vegetation parameter file 1. Soil parameter file 1. Surface forcing data / vegetation and soil ancillary files 1. Meteorological forcing – offline CABLE only 1. Restart file
16. Warnings
17. Model spin-up – offline only
18. CASA-CNP set up
19. THE CABLE MODEL CODE
20. Fortran files in CABLE subdirectories
21. Coupling of CABLE to the UM
22. Making changes to the CABLE code with version control
23. Known Issues
24. Acknowledgements
25. References
26. Appendix A: Vegetation types used in example files
27. Appendix B: CABLE parameters
28. Appendix C: Variables to be initialized
29. Appendix D: Output data available for offline simulations
30. Appendix E: STASH variables used by CABLE
31. Appendix F: Example netcdf header of meteorological forcing file with land compression