diff --git a/documentation/docs/user_guide/inputs/cable_nml.md b/documentation/docs/user_guide/inputs/cable_nml.md index cb0251651..387e8f4bb 100644 --- a/documentation/docs/user_guide/inputs/cable_nml.md +++ b/documentation/docs/user_guide/inputs/cable_nml.md @@ -45,7 +45,7 @@ applications. The following are annotated examples of cable.nml: check%energy_bal = .TRUE. ! energy balance check%mass_bal = .TRUE. ! water/mass balance verbose = .TRUE. ! write details of every grid cell init and params to log? - leaps = .TRUE. ! calculate timing with leap years? + leaps = .TRUE. ! calculate timing with leap years logn = 88 ! log file number - declared in input module fixedCO2 = 350.0 ! if not found in met file, in ppmv spincasa = .FALSE. ! spin casa before running the model if TRUE, and should be set to FALSE if spincasainput = .TRUE. @@ -89,14 +89,14 @@ applications. The following are annotated examples of cable.nml: | filename%path | character(len=500) | any string of max. 500 characters | './' | Path for output and restart files for CABLE and CASA. | | filename%out | character(len=500) | any string of max. 500 characters | uninitialised | Output file name. | | filename%log | character(len=500) | any string of max. 500 characters | uninitialised | Execution log file name. | -| filename%restart_in | character(len=500) | any string of max. 500 characters | ' ' | Input restart file name. '' means curent directory. | +| filename%restart_in | character(len=500) | any string of max. 500 characters | ' ' | Input restart file name. `''` will first search for `./__cable_rst.nc` and if not found, it uses default parameters. | | filename%restart_out | character(len=500) | any string of max. 500 characters | uninitialised | Output restart file name. | | filename%type | character(len=500) | any string of max. 500 characters | uninitialised | Static information file about grid, soil and vegetation. | | filename%lai | character(len=500) | any string of max. 500 characters | uninitialised | Default leaf area index file name. | | filename%soilcolor | character(len=500) | any string of max. 500 characters | uninitialised | Soil color (soilcolor_global_1x1.nc) file name. | | filename%soilIGBP | character(len=500) | any string of max. 500 characters | uninitialised | IGBP soil map file name. Not used? Use filename%type in stead. | | filename%inits | character(len=500) | any string of max. 500 characters | uninitialised | Initialisations file name. Not used. | -| filename%gw_elev | character(len=500) | any string of max. 500 characters | uninitialised | Elevation data filename. This data is used by the groundwater option only. | +| filename%gw_elev | character(len=500) | any string of max. 500 characters | uninitialised | Elevation data filename. This data is used by the groundwater option only. | | filename%fxpft | character(len=500) | any string of max. 500 characters | uninitialised | PFT fraction and transition, wood harvest, secondary harvest. | | filename%fxluh2cable | character(len=500) | any string of max. 500 characters | uninitialised | 12 land-use states into 17 CABLE plant functional types mapping file name. | | filename%gridnew | character(len=500) | any string of max. 500 characters | uninitialised | Updated gridinfo file name. | @@ -115,13 +115,13 @@ applications. The following are annotated examples of cable.nml: | output%veg | logical | .TRUE. .FALSE. | .FALSE. | Output vegetation states when .TRUE. | | output%params | logical | .TRUE. .FALSE. | .FALSE. | Output the input parameters used to produce run then .TRUE. | | output%balances | logical | .TRUE. .FALSE. | .FALSE. | Output energy and water balances when .TRUE. | -| output%grid | character(len=7) | 'default' 'land' 'mask' 'ALMA' | 'default' | Output grid. 'default is the same as the met file'. | +| output%grid | character(len=7) | 'default' 'land' 'mask' 'ALMA' | 'default' | Output grid convention. `land` outputs land-only points, `'mask'` outputs masked spatial grids. `'ALMA'` uses the Assistance for Land-surface Modelling Activities convention. `'default'` uses the whichever convention the input meteorological file is using. | | output%averaging | character(len=7) | 'all' 'daily' 'monthly' 'user6' | 'all' | Output averaging. | -| check%ranges | logical | .TRUE. .FALSE. | uninitialised | Check input and output variables against valid ranges | -| check%energy_bal | logical | .TRUE. .FALSE. | uninitialised | Check the energy balance | -| check%mass_bal | logical | .TRUE. .FALSE. | uninttialised | Check the water/mass balance | +| check%ranges | logical | .TRUE. .FALSE. | uninitialised | Check input and output variables against valid ranges | +| check%energy_bal | logical | .TRUE. .FALSE. | uninitialised | Check the energy balance | +| check%mass_bal | logical | .TRUE. .FALSE. | uninttialised | Check the water/mass balance | | verbose | logical | .TRUE. .FALSE. | uninitialised | Write details of every grid cell initialisation and parameters to log. | -| leaps | logical | .TRUE. .FALSE. | depends on configuration | Calculate timing with leap years? | +| leaps | logical | .TRUE. .FALSE. | depends on configuration | Calculate timing with leap years. | | logn | integer | any integer number | uninitialised | Log file number - declared in input module | | fixedCO2 | real | any real number | 350 | CO2 concentration if not found in met file, in ppmv | | spincasa | logical | .TRUE. .FALSE. | uninitialised | Spin CASA before running the model if TRUE, and should be set to FALSE if spincasainput |