From bf5ed8bcf8dd775e4bd45edfeb4e299d9fb47190 Mon Sep 17 00:00:00 2001 From: Tammas Loughran Date: Tue, 27 Jun 2023 15:02:58 +1000 Subject: [PATCH 01/13] cable.nml descrition table improvements. --- .../docs/user_guide/inputs/cable_nml.md | 194 ++++++++++++------ 1 file changed, 130 insertions(+), 64 deletions(-) diff --git a/documentation/docs/user_guide/inputs/cable_nml.md b/documentation/docs/user_guide/inputs/cable_nml.md index 07c428276..af7b23dbb 100644 --- a/documentation/docs/user_guide/inputs/cable_nml.md +++ b/documentation/docs/user_guide/inputs/cable_nml.md @@ -18,7 +18,7 @@ applications. The following are annotated examples of cable.nml: ## For offline applications ## -``` fortran-free-form +```fortran-free-form &cable filename%met = '/projects/access/CABLE-AUX/offline/TumbaFluxnet.1.3_met.nc' filename%out = 'out_cable.nc' @@ -83,74 +83,140 @@ applications. The following are annotated examples of cable.nml: &end ``` -| Namelist variable | Type | Available values | Default value | Description | -|------------------------------|-----------|-------------------------------------|------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------| -| filename%met | character(len=500) | any string of max. 500 characters | '/projects/access/CABLE-AUX/offline/TumbaFluxnet.1.3_met.nc' | Meteorological forcing file | -| filename%out | character(len=500) | any string of max. 500 characters | 'out_cable.nc' | Output file | -| filename%log | character(len=500) | any string of max. 500 characters | 'log_cable.txt' | Log file | -| filename%restart_in | character(len=500) | any string of max. 500 characters | ' ' | Input restart file | -| filename%restart_out | character(len=500) | any string of max. 500 characters | './restart_out.nc' | Output restart file | -| filename%type | character(len=500) | any string of max. 500 characters | '/projects/access/CABLE-AUX/offline/gridinfo_CSIRO_1x1.nc' | Static information file about grid, soil and vegetation | -| vegparmnew | logical | .TRUE. .FALSE. | .TRUE. | Use new format for vegetation parameter files when true | -| soilparmnew | logical | .TRUE. .FALSE. | .TRUE. | Use new format for soil parameter files when true | -| spinup | logical | .TRUE. .FALSE. | .TRUE. | Spin up the model when .TRUE. | -| delsoilM | real | any real number | 0.001 | Allowed variation in soil moisture for spin up | -| delsoilT | real | any real number | 0.01 | Allowed variation in soil temperature for spin up | -| output%restart | logical | .TRUE. .FALSE. | .TRUE. | Create a restart file when .TRUE. | -| output%met | logical | .TRUE. .FALSE. | .TRUE. | Use input meteorological data when .TRUE. | -| output%flux | logical | .TRUE. .FALSE. | .TRUE. | Convective, runoff, NEE | -| output%soil | logical | .TRUE. .FALSE. | .TRUE. | Use soil states when .TRUE. | -| output%snow | logical | .TRUE. .FALSE. | .TRUE. | Use snow states when .TRUE. | -| output%radiation | logical | .TRUE. .FALSE. | .TRUE. | Net rad, albedo | -| output%carbon | logical | .TRUE. .FALSE. | .TRUE. | NEE, GPP, NPP, stores | -| output%veg | logical | .TRUE. .FALSE. | .TRUE. | Vegetation states | -| output%params | logical | .TRUE. .FALSE. | .TRUE. | Input parameters used to produce run | -| output%balances | logical | .TRUE. .FALSE. | .TRUE. | Energy and water balances | -| check%ranges | logical | .TRUE. .FALSE. | .FALSE. | Variable ranges, input and output | -| check%energy_bal | logical | .TRUE. .FALSE. | .TRUE. | Energy balance | -| check%mass_bal | logical | .TRUE. .FALSE. | .TRUE. | Water/mass balance | -| verbose | logical | .TRUE. .FALSE. | .TRUE. | Write details of every grid cell initialisation and parameters to log. | -| leaps | logical | .TRUE. .FALSE. | .TRUE. | Calculate timing with leap years? | -| logn | integer | any integer number | 88 | 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. | .FALSE. | Spin CASA before running the model if TRUE, and should be set to FALSE if spincasainput | -| l_casacnp | logical | .TRUE. .FALSE. | .FALSE. | Use CASA-CNP with CABLE | -| l_laiFeedbk | logical | .TRUE. .FALSE. | .FALSE. | Use prognostic LAI | -| l_vcmaxFeedbk | logical | .TRUE. .FALSE. | .FALSE. | Use prognostic Vcmax | -| icycle | integer | 0, 1, 2, 3, >10 | 0 | 0 for not using casaCNP, 1 for C, 2 for C+N, 3 for C+N+P, >10 excludes call to CBM (main call to cable) | -| casafile%cnpipool | character(len=99) | any string of max. 99 characters | '/projects/access/CABLE-AUX/core/biogeochem/poolcnpInTumbarumba.csv' | Initial CNP pools file. | -| casafile%cnpbiome | character(len=99) | any string of max. 99 characters | '/projects/access/CABLE-AUX/core/biogeochem/pftlookup_csiro_v16_17tiles.csv' | Biome specific biogeochemical parameters | -| casafile%cnpepool | character(len=99) | any string of max. 99 characters | 'poolcnpOut.csv' | End of run pool size | -| casafile%cnpmetout | character(len=99) | any string of max. 99 characters | 'casamet.nc' | Output daily met forcing for spinning CASA-CNP | -| casafile%cnpmetin | character(len=99) | any string of max. 99 characters | '' | List of daily met files for spinning CASA-CNP | -| casafile%phen | character(len=99) | any string of max. 99 characters | '/projects/access/CABLE-AUX/core/biogeochem/modis_phenology_csiro.txt' | Modis phenology | -| casafile%cnpflux | character(len=99) | any string of max. 99 characters | 'cnpfluxOut.csv' | Output file for CNP fluxes | -| ncciy | integer | | 0 | GSWP year. 0 for not using GSWP; 4-digit year input for year of GSWP meteorological forcing. | -| gswpfile%rainf | character(len=200) | any string of max. 200 characters | 'gswp/Rainf_gswp1987.nc' | Input file for rain meteorological forcing. | -| gswpfile%snowf | character(len=200) | any string of max. 200 characters | 'gswp/Snowf_gswp1987.nc' | Input file for snow meteorological forcing. | -| gswpfile%LWdown | character(len=200) | any string of max. 200 characters | 'gswp/LWdown_srb1987.nc' | Input file for long wave radiation meteorological forcing. | -| gswpfile%SWdown | character(len=200) | any string of max. 200 characters | 'gswp/SWdown_srb1987.nc' | Input file for short wave radiation meteorological forcing. | -| gswpfile%PSurf | character(len=200) | any string of max. 200 characters | 'gswp/PSurf_ecor1987.nc' | Input file for surface pressure meteorological forcing. | -| gswpfile%Qair | character(len=200) | any string of max. 200 characters | 'gswp/Qair_cru1987.nc' | Input file for humidity meteorological forcing. | -| gswpfile%Tair | character(len=200) | any string of max. 200 characters | 'gswp/Tair_cru1987.nc' | Input file for temperature meteorological forcing. | -| gswpfile%wind | character(len=200) | any string of max. 200 characters | 'gswp/Wind_ncep1987.nc' | Input file for wind meteorological forcing. | -| redistrb | logical | .TRUE. .FALSE. | .FALSE. | Turn on/off the hydraulic redistribution. | -| wiltParam | real | | 0.5 | Wilt parameter in hydraulic redistribution module. | -| satuParam | real | | 0.8 | Saturation parameter in hydraulic redistribution module. | -| cable_user%FWSOIL_SWITCH | character | 'standard' 'non-linear extrapolation' 'Lai and Ktaul 2000' | 'standard' | Controls root water uptake function. | -| cable_user%DIAG_SOIL_RESP | character(len=3) | 'ON ' 'OFF' | 'ON ' | Controls soil respiration scheme when CASA-CNP not used. | -| cable_user%LEAF_RESPIRATION | character(len=3) | 'ON ' 'OFF' | 'ON ' | Controls what is output into the GPP stash variable. | -| cable_user%RUN_DIAG_LEVEL | character | 'BASIC' 'NONE' | 'BASIC' | Controls output from CABLE to standard out. | -| cable_user%CONSISTENCY_CHECK | logical | .TRUE. .FALSE. | .TRUE. | TRUE outputs combined fluxes at each timestep for comparison to a control run | -| cable_user%CASA_DUMP_READ | logical | .TRUE. .FALSE. | .FALSE. | TRUE reads CASA forcing from netcdf format | -| cable_user%CASA_DUMP_WRITE | logical | .TRUE. .FALSE. | .FALSE. | TRUE outputs CASA forcing in netcdf format | -| cable_user%SSNOW_POTEV | character(len=3) | 'HDM' 'P-M' | 'HDM' | Use the "Humidity Deficit Method" or "Penman-Monteith" method | +| Namelist variable | Type | Available values | Default value | Description | +|----------------------------------|--------------------|------------------------------------------------------------|----------------------------------|---------------------------------------------------------------------------------------------------------| +| filename%met | character(len=500) | any string of max. 500 characters | uninitialised | Meteorological forcing file name. | +| 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. | +| 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%veg | character(len=500) | any string of max. 500 characters | uninitialised | Vegetation parameters file name. Not used? | +| filename%soil | character(len=500) | any string of max. 500 characters | uninitialised | Soil parameters file name. Not used? | +| 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 | gw/elevation data file name. | +| 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. | +| vegparmnew | logical | .TRUE. .FALSE. | .FALSE. but was .TRUE. in ESM1.5 | Use new format for vegetation parameter files when .TRUE. | +| soilparmnew | logical | .TRUE. .FALSE. | uninitialised | Use new format for soil parameter files when .TRUE. | +| spinup | logical | .TRUE. .FALSE. | .FALSE. | Spin up the model when .TRUE. | +| delsoilM | real | any real number | uninitialised | Allowed variation in soil moisture for spin up | +| delsoilT | real | any real number | uninitialised | Allowed variation in soil temperature for spin up | +| output%restart | logical | .TRUE. .FALSE. | uninitialised | Create a restart file when .TRUE. | +| output%met | logical | .TRUE. .FALSE. | .FALSE. | Output input meteorological data when .TRUE. | +| output%flux | logical | .TRUE. .FALSE. | .FALSE. | Output convective, runoff, NEE | +| output%soil | logical | .TRUE. .FALSE. | .FALSE. | Output soil states when .TRUE. | +| output%snow | logical | .TRUE. .FALSE. | .FALSE. | Output snow states when .TRUE. | +| output%radiation | logical | .TRUE. .FALSE. | .FALSE. | Output Net rad, albedo when .TRUE. | +| output%carbon | logical | .TRUE. .FALSE. | .FALSE. | Output NEE, GPP, NPP, stores when .TRUE. | +| 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%averaging | character(len=7) | 'all' 'daily' 'monthly' 'user6' | 'all' | Output averaging. | +| check%ranges | logical | .TRUE. .FALSE. | uninitialised | Variable ranges, input and output | +| check%energy_bal | logical | .TRUE. .FALSE. | uninitialised | Energy balance | +| check%mass_bal | logical | .TRUE. .FALSE. | uninttialised | 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? | +| 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 | +| l_casacnp | logical | .TRUE. .FALSE. | .FALSE. | Use CASA-CNP with CABLE | +| l_landuse | logical | .TRUE. .FALSE. | .FALSE. | Use land-use change. | +| l_laiFeedbk | logical | .TRUE. .FALSE. | .FALSE. | Use prognostic leaf area index. | +| l_vcmaxFeedbk | logical | .TRUE. .FALSE. | .FALSE. | Use prognostic Vcmax | +| CASAonly | logical | .TRUE. .FALSE. | .FALSE. | ONLY run CASA-CNP. | +| icycle | integer | 0, 1, 2, 3, >10 | 0 | 0 for not using casaCNP, 1 for C, 2 for C+N, 3 for C+N+P, >10 excludes call to CBM (main call to cable) | +| casafile%cnpipool | character(len=99) | any string of max. 99 characters | '' | Initial CNP pool sise file name. | +| casafile%cnpbiome | character(len=99) | any string of max. 99 characters | uninitialised | Biome specific biogeochemical parameters file name. | +| casafile%cnpepool | character(len=99) | any string of max. 99 characters | uninitialised | End of run pool size file name. | +| casafile%cnpmetout | character(len=99) | any string of max. 99 characters | uninitialised | Output daily met forcing for spinning CASA-CNP file name. | +| casafile%cnpmetin | character(len=99) | any string of max. 99 characters | uninitialised | List of daily met files for spinning CASA-CNP file name. | +| casafile%phen | character(len=99) | any string of max. 99 characters | uninitialised | Modis phenology file name. | +| casafile%cnpflux | character(len=99) | any string of max. 99 characters | uninitialised | Output file name for CNP fluxes | +| casafile%c2cdumppath | character(len=99) | any string of max. 99 characters | '' | CABLE to CASA dump for CASA spin up. | +| ncciy | integer | | uninitialised | GSWP year. 0 for not using GSWP; 4-digit year input for year of GSWP meteorological forcing. | +| gswpfile%rainf | character(len=200) | any string of max. 200 characters | uninitialised | Input file for rain meteorological forcing. | +| gswpfile%snowf | character(len=200) | any string of max. 200 characters | uninitialised | Input file for snow meteorological forcing. | +| gswpfile%LWdown | character(len=200) | any string of max. 200 characters | uninitialised | Input file for long wave radiation meteorological forcing. | +| gswpfile%SWdown | character(len=200) | any string of max. 200 characters | uninitialised | Input file for short wave radiation meteorological forcing. | +| gswpfile%PSurf | character(len=200) | any string of max. 200 characters | uninitialised | Input file for surface pressure meteorological forcing. | +| gswpfile%Qair | character(len=200) | any string of max. 200 characters | uninitialised | Input file for humidity meteorological forcing. | +| gswpfile%Tair | character(len=200) | any string of max. 200 characters | uninitialised | Input file for temperature meteorological forcing. | +| gswpfile%wind | character(len=200) | any string of max. 200 characters | uninitialised | Input file for wind meteorological forcing. | +| redistrb | logical | .TRUE. .FALSE. | .FALSE. | Turn on/off the hydraulic redistribution. | +| wiltParam | real | | 0.0 | Wilt parameter in hydraulic redistribution module. | +| satuParam | real | | 0.0 | Saturation parameter in hydraulic redistribution module. | +| cable_user%FWSOIL_SWITCH | character | 'standard' 'non-linear extrapolation' 'Lai and Ktaul 2000' | '' | Controls root water uptake function. | +| cable_user%DIAG_SOIL_RESP | character(len=3) | 'ON' 'OFF' | '' | Controls soil respiration scheme when CASA-CNP not used. | +| cable_user%LEAF_RESPIRATION | character(len=3) | 'ON' 'OFF' | uninitialised | Controls what is output into the GPP stash variable. | +| cable_user%RUN_DIAG_LEVEL | character | 'BASIC' 'NONE' | uninitialised | Controls output from CABLE to standard out. | +| cable_user%CONSISTENCY_CHECK | logical | .TRUE. .FALSE. | .FALSE. | TRUE outputs combined fluxes at each timestep for comparison to a control run | +| cable_user%CASA_DUMP_READ | logical | .TRUE. .FALSE. | .FALSE. | TRUE reads CASA forcing from netcdf format | +| cable_user%CASA_DUMP_WRITE | logical | .TRUE. .FALSE. | .FALSE. | TRUE outputs CASA forcing in netcdf format | +| cable_user%SSNOW_POTEV | character(len=3) | 'HDM' 'P-M' | '' | Use the “Humidity Deficit Method” or “Penman-Monteith” method | +| cable_user%GS_SWITCH | character(len=20) | 'medlyn' 'leuning' | 'medlyn' | Stomatal conductance model. | +| cable_user%l_revised_coupling | logical | .TRUE. .FALSE. | .FALSE. | Revised coupling on implicit step of ACCESS-CM2. | +| cable_user%l_rev_corr | logical | .TRUE. .FALSE. | .FALSE. | Apply revised sensitvity/correction terms to soilsnow energy balance. | +| cable_user%soil_thermal_fix | logical | .TRUE. .FALSE. | .FALSE. | Snow capping depth? | +| cable_user%phenology_switch | character(len=20) | 'MODIS' 'climate' | 'MODIS' | ? | +| cable_user%RunIden | character(len=10) | any string of max. 10 characters | 'STANDARD' | Snow capping depth? | +| cable_user%MetType | character(len=6) | any string of max. 6 characters | ' ' | ? | +| cable_user%soil_struc | character(len=20) | 'default' 'sli' | 'default' | ? | +| cable_user%POP_out | character(len=3) | 'epi' 'rst' | 'rst' | ? | +| cable_user%POP_rst | character(len=50) | any string of max. 50 characters | ' ' | ? | +| cable_user%casa_out_freq | character(len=8) | 'daily' 'monthly' 'annually' | 'annually' | ? | +| cable_user%vcmax | character(len=10) | 'standard' 'Walker2014' | 'standard' | ? | +| cable_user%POPLUC_RunType | character(len=10) | 'static' 'init' 'restart' | 'static' | ? | +| cable_user%call_pop | logical | .TRUE. .FALSE. | .FALSE., | ? | +| cable_user%POP_fromZero | logical | .TRUE. .FALSE. | .FALSE., | ? | +| cable_user%call_climate | logical | .TRUE. .FALSE. | .FALSE., | ? | +| cable_user%climate_fromzero | logical | .TRUE. .FALSE. | .FALSE., | ? | +| cable_user%CASA_fromzero | logical | .TRUE. .FALSE. | .FALSE., | ? | +| cable_user%POPLUC | logical | .TRUE. .FALSE. | .FALSE., | ? | +| cable_user%casa_spin_startyear | integer | any integer | 1950 | ? | +| cable_user%casa_spin_endyear | integer | any integer | 1960 | ? | +| cable_user%yearstart | integer | any integer | 0 | ? | +| cable_user%yearend | integer | any integer | 0 | ? | +| cable_user%casa_nrep | integer | any integer | 1 | ? | +| cable_user%run_diag_level | character(len=5) | any string of max. 5 characters | uninitialised | ? | +| cable_user%leaf_respiration | character(len=3) | 'ON' 'OFF' | uninitialised | ? | +| cable_user%smrf_name | character(len=10) | 'CASA-CNP' 'SOILN' 'TRIFFID' | uninitialised | Soil Moist Respiration Function. | +| cable_user%strf_name | character(len=10) | 'CASA-CNP' 'SOILN' 'TRIFFID' | uninitialised | Soil Temp Respiration Function. | +| cable_user%initialize_mapping | logical | .TRUE. .FALSE. | .FALSE., | ? | +| cable_user%consistency_check | logical | .TRUE. .FALSE. | .FALSE., | ? | +| cable_user%casa_dump_read | logical | .TRUE. .FALSE. | .FALSE., | ? | +| cable_user%casa_dump_write | logical | .TRUE. .FALSE. | .FALSE., | ? | +| cable_user%cable_runtime_coupled | logical | .TRUE. .FALSE. | .TRUE., | ? | +| cable_user%LogWorker | logical | .TRUE. .FALSE. | .TRUE., | Write Output of each worker | +| cable_user%l_new_roughness_soil | logical | .TRUE. .FALSE. | .FALSE., | ? | +| cable_user%l_new_runoff_speed | logical | .TRUE. .FALSE. | .FALSE., | ? | +| cable_user%l_new_reduce_soilevp | logical | .TRUE. .FALSE. | .FALSE., | ? | +| cable_user%srf | logical | .TRUE. .FALSE. | .FALSE., | Switch for customized soil respiration | +| cable_user%litter | logical | .TRUE. .FALSE. | .FALSE., | ? | +| cable_user%gw_model | logical | .TRUE. .FALSE. | .FALSE., | ? | +| cable_user%alt_forcing | logical | .TRUE. .FALSE. | .FALSE., | ? | +| cable_user%gswp3 | logical | .TRUE. .FALSE. | .FALSE., | Use GSWP3 forcing. | +| cable_user%or_evap | logical | .TRUE. .FALSE. | .FALSE., | ? | +| cable_user%test_new_gw | logical | .TRUE. .FALSE. | .FALSE., | ? | +| cable_user%sync_nc_file | logical | .TRUE. .FALSE. | .FALSE., | ? | +| cable_user%max_spins | integer | any integer | 1 | ? | +| cable_user%fix_access_roots | logical | .TRUE. .FALSE. | .FALSE., | use pft dependent roots in ACCESS | +| cable_user%access13roots | logical | .TRUE. .FALSE. | .FALSE., | Switch to use ACCESS1.3 %froot. | +| cable_user%l_limit_labile | logical | .TRUE. .FALSE. | .FALSE., | Limit Labile in spinup | +| cable_user%NtilesThruMetFile | logical | .TRUE. .FALSE. | .FALSE., | Specify Ntiles through met file | ## For ACCESS applications ## -``` fortran-free-form +```fortran-free-form &cable !! !! cable namelist variables applicable to ACCESS/UM runs From d96c9bce509746fd1efd1c566b0631e889b30ee6 Mon Sep 17 00:00:00 2001 From: Tammas Loughran Date: Tue, 27 Jun 2023 15:09:30 +1000 Subject: [PATCH 02/13] Remove filename%veg and soil. --- documentation/docs/user_guide/inputs/cable_nml.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/documentation/docs/user_guide/inputs/cable_nml.md b/documentation/docs/user_guide/inputs/cable_nml.md index af7b23dbb..da71947f1 100644 --- a/documentation/docs/user_guide/inputs/cable_nml.md +++ b/documentation/docs/user_guide/inputs/cable_nml.md @@ -89,12 +89,10 @@ 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. | +| filename%restart_in | character(len=500) | any string of max. 500 characters | ' ' | Input restart file name. '' means curent directory. | | 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%veg | character(len=500) | any string of max. 500 characters | uninitialised | Vegetation parameters file name. Not used? | -| filename%soil | character(len=500) | any string of max. 500 characters | uninitialised | Soil parameters file name. Not used? | | 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. | From 02c92ccafaaf2b9f770bb0d7b2d93dd2df67760d Mon Sep 17 00:00:00 2001 From: Tammas Loughran Date: Tue, 27 Jun 2023 15:27:10 +1000 Subject: [PATCH 03/13] Added some more descriptions --- .../docs/user_guide/inputs/cable_nml.md | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/documentation/docs/user_guide/inputs/cable_nml.md b/documentation/docs/user_guide/inputs/cable_nml.md index da71947f1..680ca4379 100644 --- a/documentation/docs/user_guide/inputs/cable_nml.md +++ b/documentation/docs/user_guide/inputs/cable_nml.md @@ -18,7 +18,7 @@ applications. The following are annotated examples of cable.nml: ## For offline applications ## -```fortran-free-form +```fortran &cable filename%met = '/projects/access/CABLE-AUX/offline/TumbaFluxnet.1.3_met.nc' filename%out = 'out_cable.nc' @@ -139,7 +139,7 @@ applications. The following are annotated examples of cable.nml: | casafile%phen | character(len=99) | any string of max. 99 characters | uninitialised | Modis phenology file name. | | casafile%cnpflux | character(len=99) | any string of max. 99 characters | uninitialised | Output file name for CNP fluxes | | casafile%c2cdumppath | character(len=99) | any string of max. 99 characters | '' | CABLE to CASA dump for CASA spin up. | -| ncciy | integer | | uninitialised | GSWP year. 0 for not using GSWP; 4-digit year input for year of GSWP meteorological forcing. | +| ncciy | integer | any integer | uninitialised | GSWP year. 0 for not using GSWP; 4-digit year input for year of GSWP meteorological forcing. | | gswpfile%rainf | character(len=200) | any string of max. 200 characters | uninitialised | Input file for rain meteorological forcing. | | gswpfile%snowf | character(len=200) | any string of max. 200 characters | uninitialised | Input file for snow meteorological forcing. | | gswpfile%LWdown | character(len=200) | any string of max. 200 characters | uninitialised | Input file for long wave radiation meteorological forcing. | @@ -149,8 +149,8 @@ applications. The following are annotated examples of cable.nml: | gswpfile%Tair | character(len=200) | any string of max. 200 characters | uninitialised | Input file for temperature meteorological forcing. | | gswpfile%wind | character(len=200) | any string of max. 200 characters | uninitialised | Input file for wind meteorological forcing. | | redistrb | logical | .TRUE. .FALSE. | .FALSE. | Turn on/off the hydraulic redistribution. | -| wiltParam | real | | 0.0 | Wilt parameter in hydraulic redistribution module. | -| satuParam | real | | 0.0 | Saturation parameter in hydraulic redistribution module. | +| wiltParam | real | any real | 0.0 | Wilt parameter in hydraulic redistribution module. | +| satuParam | real | any real | 0.0 | Saturation parameter in hydraulic redistribution module. | | cable_user%FWSOIL_SWITCH | character | 'standard' 'non-linear extrapolation' 'Lai and Ktaul 2000' | '' | Controls root water uptake function. | | cable_user%DIAG_SOIL_RESP | character(len=3) | 'ON' 'OFF' | '' | Controls soil respiration scheme when CASA-CNP not used. | | cable_user%LEAF_RESPIRATION | character(len=3) | 'ON' 'OFF' | uninitialised | Controls what is output into the GPP stash variable. | @@ -164,12 +164,12 @@ applications. The following are annotated examples of cable.nml: | cable_user%l_rev_corr | logical | .TRUE. .FALSE. | .FALSE. | Apply revised sensitvity/correction terms to soilsnow energy balance. | | cable_user%soil_thermal_fix | logical | .TRUE. .FALSE. | .FALSE. | Snow capping depth? | | cable_user%phenology_switch | character(len=20) | 'MODIS' 'climate' | 'MODIS' | ? | -| cable_user%RunIden | character(len=10) | any string of max. 10 characters | 'STANDARD' | Snow capping depth? | +| cable_user%RunIden | character(len=10) | any string of max. 10 characters | 'STANDARD' | ? | | cable_user%MetType | character(len=6) | any string of max. 6 characters | ' ' | ? | | cable_user%soil_struc | character(len=20) | 'default' 'sli' | 'default' | ? | | cable_user%POP_out | character(len=3) | 'epi' 'rst' | 'rst' | ? | | cable_user%POP_rst | character(len=50) | any string of max. 50 characters | ' ' | ? | -| cable_user%casa_out_freq | character(len=8) | 'daily' 'monthly' 'annually' | 'annually' | ? | +| cable_user%casa_out_freq | character(len=8) | 'daily' 'monthly' 'annually' | 'annually' | CASA output frequency | | cable_user%vcmax | character(len=10) | 'standard' 'Walker2014' | 'standard' | ? | | cable_user%POPLUC_RunType | character(len=10) | 'static' 'init' 'restart' | 'static' | ? | | cable_user%call_pop | logical | .TRUE. .FALSE. | .FALSE., | ? | @@ -178,8 +178,8 @@ applications. The following are annotated examples of cable.nml: | cable_user%climate_fromzero | logical | .TRUE. .FALSE. | .FALSE., | ? | | cable_user%CASA_fromzero | logical | .TRUE. .FALSE. | .FALSE., | ? | | cable_user%POPLUC | logical | .TRUE. .FALSE. | .FALSE., | ? | -| cable_user%casa_spin_startyear | integer | any integer | 1950 | ? | -| cable_user%casa_spin_endyear | integer | any integer | 1960 | ? | +| cable_user%casa_spin_startyear | integer | any integer | 1950 | CASA spinup start year. | +| cable_user%casa_spin_endyear | integer | any integer | 1960 | CASA spinup end year. | | cable_user%yearstart | integer | any integer | 0 | ? | | cable_user%yearend | integer | any integer | 0 | ? | | cable_user%casa_nrep | integer | any integer | 1 | ? | @@ -192,7 +192,7 @@ applications. The following are annotated examples of cable.nml: | cable_user%casa_dump_read | logical | .TRUE. .FALSE. | .FALSE., | ? | | cable_user%casa_dump_write | logical | .TRUE. .FALSE. | .FALSE., | ? | | cable_user%cable_runtime_coupled | logical | .TRUE. .FALSE. | .TRUE., | ? | -| cable_user%LogWorker | logical | .TRUE. .FALSE. | .TRUE., | Write Output of each worker | +| cable_user%LogWorker | logical | .TRUE. .FALSE. | .TRUE., | Write output of each worker | | cable_user%l_new_roughness_soil | logical | .TRUE. .FALSE. | .FALSE., | ? | | cable_user%l_new_runoff_speed | logical | .TRUE. .FALSE. | .FALSE., | ? | | cable_user%l_new_reduce_soilevp | logical | .TRUE. .FALSE. | .FALSE., | ? | @@ -205,7 +205,7 @@ applications. The following are annotated examples of cable.nml: | cable_user%test_new_gw | logical | .TRUE. .FALSE. | .FALSE., | ? | | cable_user%sync_nc_file | logical | .TRUE. .FALSE. | .FALSE., | ? | | cable_user%max_spins | integer | any integer | 1 | ? | -| cable_user%fix_access_roots | logical | .TRUE. .FALSE. | .FALSE., | use pft dependent roots in ACCESS | +| cable_user%fix_access_roots | logical | .TRUE. .FALSE. | .FALSE., | Use pft dependent roots in ACCESS | | cable_user%access13roots | logical | .TRUE. .FALSE. | .FALSE., | Switch to use ACCESS1.3 %froot. | | cable_user%l_limit_labile | logical | .TRUE. .FALSE. | .FALSE., | Limit Labile in spinup | | cable_user%NtilesThruMetFile | logical | .TRUE. .FALSE. | .FALSE., | Specify Ntiles through met file | @@ -214,7 +214,7 @@ applications. The following are annotated examples of cable.nml: ## For ACCESS applications ## -```fortran-free-form +```fortran &cable !! !! cable namelist variables applicable to ACCESS/UM runs From bf329fddbd991a15892fec0f965d68c657014243 Mon Sep 17 00:00:00 2001 From: Tammas Loughran Date: Fri, 7 Jul 2023 14:48:27 +1000 Subject: [PATCH 04/13] Apply suggestions from code review Co-authored-by: Claire Carouge --- documentation/docs/user_guide/inputs/cable_nml.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/documentation/docs/user_guide/inputs/cable_nml.md b/documentation/docs/user_guide/inputs/cable_nml.md index 680ca4379..c6f3c97de 100644 --- a/documentation/docs/user_guide/inputs/cable_nml.md +++ b/documentation/docs/user_guide/inputs/cable_nml.md @@ -96,7 +96,7 @@ applications. The following are annotated examples of cable.nml: | 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 | gw/elevation data file name. | +| 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. | @@ -117,9 +117,9 @@ applications. The following are annotated examples of cable.nml: | 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%averaging | character(len=7) | 'all' 'daily' 'monthly' 'user6' | 'all' | Output averaging. | -| check%ranges | logical | .TRUE. .FALSE. | uninitialised | Variable ranges, input and output | -| check%energy_bal | logical | .TRUE. .FALSE. | uninitialised | Energy balance | -| check%mass_bal | logical | .TRUE. .FALSE. | uninttialised | 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? | | logn | integer | any integer number | uninitialised | Log file number - declared in input module | @@ -131,7 +131,7 @@ applications. The following are annotated examples of cable.nml: | l_vcmaxFeedbk | logical | .TRUE. .FALSE. | .FALSE. | Use prognostic Vcmax | | CASAonly | logical | .TRUE. .FALSE. | .FALSE. | ONLY run CASA-CNP. | | icycle | integer | 0, 1, 2, 3, >10 | 0 | 0 for not using casaCNP, 1 for C, 2 for C+N, 3 for C+N+P, >10 excludes call to CBM (main call to cable) | -| casafile%cnpipool | character(len=99) | any string of max. 99 characters | '' | Initial CNP pool sise file name. | +| casafile%cnpipool | character(len=99) | any string of max. 99 characters | '' | Initial CNP pool size file name. | | casafile%cnpbiome | character(len=99) | any string of max. 99 characters | uninitialised | Biome specific biogeochemical parameters file name. | | casafile%cnpepool | character(len=99) | any string of max. 99 characters | uninitialised | End of run pool size file name. | | casafile%cnpmetout | character(len=99) | any string of max. 99 characters | uninitialised | Output daily met forcing for spinning CASA-CNP file name. | @@ -184,7 +184,6 @@ applications. The following are annotated examples of cable.nml: | cable_user%yearend | integer | any integer | 0 | ? | | cable_user%casa_nrep | integer | any integer | 1 | ? | | cable_user%run_diag_level | character(len=5) | any string of max. 5 characters | uninitialised | ? | -| cable_user%leaf_respiration | character(len=3) | 'ON' 'OFF' | uninitialised | ? | | cable_user%smrf_name | character(len=10) | 'CASA-CNP' 'SOILN' 'TRIFFID' | uninitialised | Soil Moist Respiration Function. | | cable_user%strf_name | character(len=10) | 'CASA-CNP' 'SOILN' 'TRIFFID' | uninitialised | Soil Temp Respiration Function. | | cable_user%initialize_mapping | logical | .TRUE. .FALSE. | .FALSE., | ? | @@ -204,7 +203,7 @@ applications. The following are annotated examples of cable.nml: | cable_user%or_evap | logical | .TRUE. .FALSE. | .FALSE., | ? | | cable_user%test_new_gw | logical | .TRUE. .FALSE. | .FALSE., | ? | | cable_user%sync_nc_file | logical | .TRUE. .FALSE. | .FALSE., | ? | -| cable_user%max_spins | integer | any integer | 1 | ? | +| cable_user%max_spins | integer | any integer | 1 | Maximum number of iterations for a spinup. CABLE will act as if convergence has been reached after max_spins iterations even if it was not reached. | | cable_user%fix_access_roots | logical | .TRUE. .FALSE. | .FALSE., | Use pft dependent roots in ACCESS | | cable_user%access13roots | logical | .TRUE. .FALSE. | .FALSE., | Switch to use ACCESS1.3 %froot. | | cable_user%l_limit_labile | logical | .TRUE. .FALSE. | .FALSE., | Limit Labile in spinup | From aa8deb11cf957708c6202beea0002b2eadab75d2 Mon Sep 17 00:00:00 2001 From: Tammas Loughran Date: Fri, 7 Jul 2023 14:59:57 +1000 Subject: [PATCH 05/13] Remove duplicate entries from cable.nml documentation --- documentation/docs/user_guide/inputs/cable_nml.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/documentation/docs/user_guide/inputs/cable_nml.md b/documentation/docs/user_guide/inputs/cable_nml.md index c6f3c97de..cb0251651 100644 --- a/documentation/docs/user_guide/inputs/cable_nml.md +++ b/documentation/docs/user_guide/inputs/cable_nml.md @@ -154,7 +154,7 @@ applications. The following are annotated examples of cable.nml: | cable_user%FWSOIL_SWITCH | character | 'standard' 'non-linear extrapolation' 'Lai and Ktaul 2000' | '' | Controls root water uptake function. | | cable_user%DIAG_SOIL_RESP | character(len=3) | 'ON' 'OFF' | '' | Controls soil respiration scheme when CASA-CNP not used. | | cable_user%LEAF_RESPIRATION | character(len=3) | 'ON' 'OFF' | uninitialised | Controls what is output into the GPP stash variable. | -| cable_user%RUN_DIAG_LEVEL | character | 'BASIC' 'NONE' | uninitialised | Controls output from CABLE to standard out. | +| cable_user%RUN_DIAG_LEVEL | character(len=5) | 'BASIC' 'NONE' | uninitialised | Controls output from CABLE to standard out. | | cable_user%CONSISTENCY_CHECK | logical | .TRUE. .FALSE. | .FALSE. | TRUE outputs combined fluxes at each timestep for comparison to a control run | | cable_user%CASA_DUMP_READ | logical | .TRUE. .FALSE. | .FALSE. | TRUE reads CASA forcing from netcdf format | | cable_user%CASA_DUMP_WRITE | logical | .TRUE. .FALSE. | .FALSE. | TRUE outputs CASA forcing in netcdf format | @@ -183,13 +183,9 @@ applications. The following are annotated examples of cable.nml: | cable_user%yearstart | integer | any integer | 0 | ? | | cable_user%yearend | integer | any integer | 0 | ? | | cable_user%casa_nrep | integer | any integer | 1 | ? | -| cable_user%run_diag_level | character(len=5) | any string of max. 5 characters | uninitialised | ? | | cable_user%smrf_name | character(len=10) | 'CASA-CNP' 'SOILN' 'TRIFFID' | uninitialised | Soil Moist Respiration Function. | | cable_user%strf_name | character(len=10) | 'CASA-CNP' 'SOILN' 'TRIFFID' | uninitialised | Soil Temp Respiration Function. | | cable_user%initialize_mapping | logical | .TRUE. .FALSE. | .FALSE., | ? | -| cable_user%consistency_check | logical | .TRUE. .FALSE. | .FALSE., | ? | -| cable_user%casa_dump_read | logical | .TRUE. .FALSE. | .FALSE., | ? | -| cable_user%casa_dump_write | logical | .TRUE. .FALSE. | .FALSE., | ? | | cable_user%cable_runtime_coupled | logical | .TRUE. .FALSE. | .TRUE., | ? | | cable_user%LogWorker | logical | .TRUE. .FALSE. | .TRUE., | Write output of each worker | | cable_user%l_new_roughness_soil | logical | .TRUE. .FALSE. | .FALSE., | ? | From 032d9ae0e5e5c92a02aa35758bb01f2c53f001de Mon Sep 17 00:00:00 2001 From: Tammas Loughran Date: Fri, 7 Jul 2023 15:10:55 +1000 Subject: [PATCH 06/13] Corrections from suggesed changes discussion --- .../docs/user_guide/inputs/cable_nml.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) 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 | From 5f5135414ceb077d2d44e6e59d8965ae8c1c0e76 Mon Sep 17 00:00:00 2001 From: Tammas Loughran Date: Fri, 7 Jul 2023 15:46:44 +1000 Subject: [PATCH 07/13] Added descriptions for cable.nml documentation. --- documentation/docs/user_guide/inputs/cable_nml.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/documentation/docs/user_guide/inputs/cable_nml.md b/documentation/docs/user_guide/inputs/cable_nml.md index 387e8f4bb..71343bee3 100644 --- a/documentation/docs/user_guide/inputs/cable_nml.md +++ b/documentation/docs/user_guide/inputs/cable_nml.md @@ -163,12 +163,12 @@ applications. The following are annotated examples of cable.nml: | cable_user%l_revised_coupling | logical | .TRUE. .FALSE. | .FALSE. | Revised coupling on implicit step of ACCESS-CM2. | | cable_user%l_rev_corr | logical | .TRUE. .FALSE. | .FALSE. | Apply revised sensitvity/correction terms to soilsnow energy balance. | | cable_user%soil_thermal_fix | logical | .TRUE. .FALSE. | .FALSE. | Snow capping depth? | -| cable_user%phenology_switch | character(len=20) | 'MODIS' 'climate' | 'MODIS' | ? | -| cable_user%RunIden | character(len=10) | any string of max. 10 characters | 'STANDARD' | ? | -| cable_user%MetType | character(len=6) | any string of max. 6 characters | ' ' | ? | -| cable_user%soil_struc | character(len=20) | 'default' 'sli' | 'default' | ? | -| cable_user%POP_out | character(len=3) | 'epi' 'rst' | 'rst' | ? | -| cable_user%POP_rst | character(len=50) | any string of max. 50 characters | ' ' | ? | +| cable_user%phenology_switch | character(len=20) | 'MODIS' 'climate' | 'MODIS' | Use prescribed MODIS phenology or climate dependant phenology. | +| cable_user%RunIden | character(len=10) | any string of max. 10 characters | 'STANDARD' | Run identifier string for input/output files. | +| cable_user%MetType | character(len=6) | '' 'gswp' 'gswp3' 'gpgs' 'plum' 'cru' 'site' 'bios' | ' ' | Type of input meteorological data. | +| cable_user%soil_struc | character(len=20) | 'default' 'sli' | 'default' | Use default or soil-litter-iso soil model. | +| cable_user%POP_out | character(len=3) | 'epi' 'rst' 'ini' | 'rst' | POP restart file type. `epi` is end of year state `'rst'` is a standard restart file, `'ini'` is an initialisation restart file. | +| cable_user%POP_rst | character(len=50) | any string of max. 50 characters | ' ' | POP restart file directory. | | cable_user%casa_out_freq | character(len=8) | 'daily' 'monthly' 'annually' | 'annually' | CASA output frequency | | cable_user%vcmax | character(len=10) | 'standard' 'Walker2014' | 'standard' | ? | | cable_user%POPLUC_RunType | character(len=10) | 'static' 'init' 'restart' | 'static' | ? | From 76264702b3c5e07e294adbc5f7d5b29b4d874ce5 Mon Sep 17 00:00:00 2001 From: Tammas Loughran Date: Fri, 14 Jul 2023 13:26:29 +1000 Subject: [PATCH 08/13] Removed some redundant entries from namelist documentation and added some more descriptions. --- .../docs/user_guide/inputs/cable_nml.md | 49 +++++++++---------- 1 file changed, 23 insertions(+), 26 deletions(-) diff --git a/documentation/docs/user_guide/inputs/cable_nml.md b/documentation/docs/user_guide/inputs/cable_nml.md index 71343bee3..45d871ffd 100644 --- a/documentation/docs/user_guide/inputs/cable_nml.md +++ b/documentation/docs/user_guide/inputs/cable_nml.md @@ -115,7 +115,7 @@ 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 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%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 | @@ -162,44 +162,41 @@ applications. The following are annotated examples of cable.nml: | cable_user%GS_SWITCH | character(len=20) | 'medlyn' 'leuning' | 'medlyn' | Stomatal conductance model. | | cable_user%l_revised_coupling | logical | .TRUE. .FALSE. | .FALSE. | Revised coupling on implicit step of ACCESS-CM2. | | cable_user%l_rev_corr | logical | .TRUE. .FALSE. | .FALSE. | Apply revised sensitvity/correction terms to soilsnow energy balance. | -| cable_user%soil_thermal_fix | logical | .TRUE. .FALSE. | .FALSE. | Snow capping depth? | +| cable_user%soil_thermal_fix | logical | .TRUE. .FALSE. | .FALSE. | Use alternative soil conductivity implementation. | | cable_user%phenology_switch | character(len=20) | 'MODIS' 'climate' | 'MODIS' | Use prescribed MODIS phenology or climate dependant phenology. | | cable_user%RunIden | character(len=10) | any string of max. 10 characters | 'STANDARD' | Run identifier string for input/output files. | | cable_user%MetType | character(len=6) | '' 'gswp' 'gswp3' 'gpgs' 'plum' 'cru' 'site' 'bios' | ' ' | Type of input meteorological data. | | cable_user%soil_struc | character(len=20) | 'default' 'sli' | 'default' | Use default or soil-litter-iso soil model. | -| cable_user%POP_out | character(len=3) | 'epi' 'rst' 'ini' | 'rst' | POP restart file type. `epi` is end of year state `'rst'` is a standard restart file, `'ini'` is an initialisation restart file. | -| cable_user%POP_rst | character(len=50) | any string of max. 50 characters | ' ' | POP restart file directory. | -| cable_user%casa_out_freq | character(len=8) | 'daily' 'monthly' 'annually' | 'annually' | CASA output frequency | -| cable_user%vcmax | character(len=10) | 'standard' 'Walker2014' | 'standard' | ? | -| cable_user%POPLUC_RunType | character(len=10) | 'static' 'init' 'restart' | 'static' | ? | -| cable_user%call_pop | logical | .TRUE. .FALSE. | .FALSE., | ? | -| cable_user%POP_fromZero | logical | .TRUE. .FALSE. | .FALSE., | ? | -| cable_user%call_climate | logical | .TRUE. .FALSE. | .FALSE., | ? | -| cable_user%climate_fromzero | logical | .TRUE. .FALSE. | .FALSE., | ? | -| cable_user%CASA_fromzero | logical | .TRUE. .FALSE. | .FALSE., | ? | -| cable_user%POPLUC | logical | .TRUE. .FALSE. | .FALSE., | ? | +| cable_user%POP_out | character(len=3) | 'epi' 'rst' 'ini' | 'rst' | POP restart file type. `'epi'` is end of year state `'rst'` is a standard restart file, `'ini'` is an initialisation restart file. | +| cable_user%POP_rst | character(len=50) | any string of max. 50 characters | ' ' | POP restart file directory. | +| cable_user%casa_out_freq | character(len=8) | 'daily' 'monthly' 'annually' | 'annually' | CASA output frequency. | +| cable_user%vcmax | character(len=10) | 'standard' 'Walker2014' | 'standard' | Alternative functional form of $V_{cmax}$ (maximum RuBP carboxylation rate). For `'Walker2014'` see https://doi.org/10.1002/ece3.1173 . | +| cable_user%POPLUC_RunType | character(len=10) | 'static' 'init' 'restart' | 'static' | Type of POP-LUC run. `'init'` is initial POP-LUC run, `'restart'` is a restart run, `'static'` disables dynamic vegetation and sets `cable_user%POPLUC = .FALSE.`.| +| cable_user%call_pop | logical | .TRUE. .FALSE. | .FALSE., | Enable POP. | +| cable_user%POP_fromZero | logical | .TRUE. .FALSE. | .FALSE., | Run POP initialisation. | +| cable_user%call_climate | logical | .TRUE. .FALSE. | .FALSE., | Track climate variables for use in phenology and potential plant functional type modules. | +| cable_user%climate_fromzero | logical | .TRUE. .FALSE. | .FALSE., | Initialise climate variables with 0. | +| cable_user%CASA_fromzero | logical | .TRUE. .FALSE. | .FALSE., | Initialize CASA from 0 without restart files. | +| cable_user%POPLUC | logical | .TRUE. .FALSE. | .FALSE., | Enable POP-LUC. | | cable_user%casa_spin_startyear | integer | any integer | 1950 | CASA spinup start year. | | cable_user%casa_spin_endyear | integer | any integer | 1960 | CASA spinup end year. | -| cable_user%yearstart | integer | any integer | 0 | ? | -| cable_user%yearend | integer | any integer | 0 | ? | -| cable_user%casa_nrep | integer | any integer | 1 | ? | -| cable_user%smrf_name | character(len=10) | 'CASA-CNP' 'SOILN' 'TRIFFID' | uninitialised | Soil Moist Respiration Function. | -| cable_user%strf_name | character(len=10) | 'CASA-CNP' 'SOILN' 'TRIFFID' | uninitialised | Soil Temp Respiration Function. | -| cable_user%initialize_mapping | logical | .TRUE. .FALSE. | .FALSE., | ? | -| cable_user%cable_runtime_coupled | logical | .TRUE. .FALSE. | .TRUE., | ? | +| cable_user%yearstart | integer | any integer | 0 | Start year of run. | +| cable_user%yearend | integer | any integer | 0 | End year of run. | +| cable_user%casa_nrep | integer | any integer | 1 | Number of repetitions of CASA spinup. | +| cable_user%smrf_name | character(len=10) | 'CASA-CNP' 'SOILN' 'TRIFFID' | uninitialised | Soil moisture respiration function. | +| cable_user%strf_name | character(len=10) | 'CASA-CNP' 'SOILN' 'TRIFFID' | uninitialised | Soil temperature respiration function. | | cable_user%LogWorker | logical | .TRUE. .FALSE. | .TRUE., | Write output of each worker | -| cable_user%l_new_roughness_soil | logical | .TRUE. .FALSE. | .FALSE., | ? | -| cable_user%l_new_runoff_speed | logical | .TRUE. .FALSE. | .FALSE., | ? | -| cable_user%l_new_reduce_soilevp | logical | .TRUE. .FALSE. | .FALSE., | ? | +| cable_user%l_new_roughness_soil | logical | .TRUE. .FALSE. | .FALSE., | Use alternative roughness and flux resistance scheme. | +| cable_user%l_new_runoff_speed | logical | .TRUE. .FALSE. | .FALSE., | Use alternative soil water drainage scheme. | +| cable_user%l_new_reduce_soilevp | logical | .TRUE. .FALSE. | .FALSE., | Use alternative soil evaporation scheme. | | cable_user%srf | logical | .TRUE. .FALSE. | .FALSE., | Switch for customized soil respiration | | cable_user%litter | logical | .TRUE. .FALSE. | .FALSE., | ? | | cable_user%gw_model | logical | .TRUE. .FALSE. | .FALSE., | ? | -| cable_user%alt_forcing | logical | .TRUE. .FALSE. | .FALSE., | ? | | cable_user%gswp3 | logical | .TRUE. .FALSE. | .FALSE., | Use GSWP3 forcing. | | cable_user%or_evap | logical | .TRUE. .FALSE. | .FALSE., | ? | | cable_user%test_new_gw | logical | .TRUE. .FALSE. | .FALSE., | ? | -| cable_user%sync_nc_file | logical | .TRUE. .FALSE. | .FALSE., | ? | -| cable_user%max_spins | integer | any integer | 1 | Maximum number of iterations for a spinup. CABLE will act as if convergence has been reached after max_spins iterations even if it was not reached. | +| cable_user%sync_nc_file | logical | .TRUE. .FALSE. | .FALSE., | Write netCDF output to file without closing during run. | +| cable_user%max_spins | integer | any integer | 1 | Maximum number of iterations for a spinup. CABLE will act as if convergence has been reached after max_spins iterations even if it was not reached. | | cable_user%fix_access_roots | logical | .TRUE. .FALSE. | .FALSE., | Use pft dependent roots in ACCESS | | cable_user%access13roots | logical | .TRUE. .FALSE. | .FALSE., | Switch to use ACCESS1.3 %froot. | | cable_user%l_limit_labile | logical | .TRUE. .FALSE. | .FALSE., | Limit Labile in spinup | From b55f4d83104434f3f526082f65dca2a147db514e Mon Sep 17 00:00:00 2001 From: Tammas Loughran Date: Fri, 14 Jul 2023 14:11:45 +1000 Subject: [PATCH 09/13] Replace link with doi in documentation --- documentation/docs/user_guide/inputs/cable_nml.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/docs/user_guide/inputs/cable_nml.md b/documentation/docs/user_guide/inputs/cable_nml.md index 45d871ffd..c123bf6dd 100644 --- a/documentation/docs/user_guide/inputs/cable_nml.md +++ b/documentation/docs/user_guide/inputs/cable_nml.md @@ -170,7 +170,7 @@ applications. The following are annotated examples of cable.nml: | cable_user%POP_out | character(len=3) | 'epi' 'rst' 'ini' | 'rst' | POP restart file type. `'epi'` is end of year state `'rst'` is a standard restart file, `'ini'` is an initialisation restart file. | | cable_user%POP_rst | character(len=50) | any string of max. 50 characters | ' ' | POP restart file directory. | | cable_user%casa_out_freq | character(len=8) | 'daily' 'monthly' 'annually' | 'annually' | CASA output frequency. | -| cable_user%vcmax | character(len=10) | 'standard' 'Walker2014' | 'standard' | Alternative functional form of $V_{cmax}$ (maximum RuBP carboxylation rate). For `'Walker2014'` see https://doi.org/10.1002/ece3.1173 . | +| cable_user%vcmax | character(len=10) | 'standard' 'Walker2014' | 'standard' | Alternative functional form of $V_{cmax}$ (maximum RuBP carboxylation rate). For `'Walker2014'` see doi:10.1002/ece3.1173 . | | cable_user%POPLUC_RunType | character(len=10) | 'static' 'init' 'restart' | 'static' | Type of POP-LUC run. `'init'` is initial POP-LUC run, `'restart'` is a restart run, `'static'` disables dynamic vegetation and sets `cable_user%POPLUC = .FALSE.`.| | cable_user%call_pop | logical | .TRUE. .FALSE. | .FALSE., | Enable POP. | | cable_user%POP_fromZero | logical | .TRUE. .FALSE. | .FALSE., | Run POP initialisation. | From 0694dac5b3593e15dcaf4f9579be3069ce051675 Mon Sep 17 00:00:00 2001 From: Tammas Loughran Date: Wed, 16 Aug 2023 12:07:02 +1000 Subject: [PATCH 10/13] Added descriptions for the last few namelist variables and minor text editing. --- .../docs/user_guide/inputs/cable_nml.md | 99 +++++++++---------- 1 file changed, 48 insertions(+), 51 deletions(-) diff --git a/documentation/docs/user_guide/inputs/cable_nml.md b/documentation/docs/user_guide/inputs/cable_nml.md index c123bf6dd..06368cd66 100644 --- a/documentation/docs/user_guide/inputs/cable_nml.md +++ b/documentation/docs/user_guide/inputs/cable_nml.md @@ -94,50 +94,48 @@ applications. The following are annotated examples of cable.nml: | 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%fxpft | character(len=500) | any string of max. 500 characters | uninitialised | PFT fraction and transition, wood harvest, secondary harvest. | +| filename%fxpft | character(len=500) | any string of max. 500 characters | uninitialised | Plant functional type fraction, wood harvest and secondary harvest file. | | 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. | | vegparmnew | logical | .TRUE. .FALSE. | .FALSE. but was .TRUE. in ESM1.5 | Use new format for vegetation parameter files when .TRUE. | | soilparmnew | logical | .TRUE. .FALSE. | uninitialised | Use new format for soil parameter files when .TRUE. | | spinup | logical | .TRUE. .FALSE. | .FALSE. | Spin up the model when .TRUE. | -| delsoilM | real | any real number | uninitialised | Allowed variation in soil moisture for spin up | -| delsoilT | real | any real number | uninitialised | Allowed variation in soil temperature for spin up | -| output%restart | logical | .TRUE. .FALSE. | uninitialised | Create a restart file when .TRUE. | -| output%met | logical | .TRUE. .FALSE. | .FALSE. | Output input meteorological data when .TRUE. | -| output%flux | logical | .TRUE. .FALSE. | .FALSE. | Output convective, runoff, NEE | -| output%soil | logical | .TRUE. .FALSE. | .FALSE. | Output soil states when .TRUE. | -| output%snow | logical | .TRUE. .FALSE. | .FALSE. | Output snow states when .TRUE. | -| output%radiation | logical | .TRUE. .FALSE. | .FALSE. | Output Net rad, albedo when .TRUE. | -| output%carbon | logical | .TRUE. .FALSE. | .FALSE. | Output NEE, GPP, NPP, stores when .TRUE. | -| 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. | +| delsoilM | real | any real number | uninitialised | Allowed variation in soil moisture for spin up. | +| delsoilT | real | any real number | uninitialised | Allowed variation in soil temperature for spin up. | +| output%restart | logical | .TRUE. .FALSE. | uninitialised | Create a restart file when .TRUE.. | +| output%met | logical | .TRUE. .FALSE. | .FALSE. | Output input meteorological data when .TRUE.. | +| output%flux | logical | .TRUE. .FALSE. | .FALSE. | Output convective, runoff, NEE. | +| output%soil | logical | .TRUE. .FALSE. | .FALSE. | Output soil states when .TRUE.. | +| output%snow | logical | .TRUE. .FALSE. | .FALSE. | Output snow states when .TRUE.. | +| output%radiation | logical | .TRUE. .FALSE. | .FALSE. | Output Net radiation and albedo when .TRUE.. | +| output%carbon | logical | .TRUE. .FALSE. | .FALSE. | Output NEE, GPP, NPP, stores when .TRUE.. | +| 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 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. | -| 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 | -| l_casacnp | logical | .TRUE. .FALSE. | .FALSE. | Use CASA-CNP with CABLE | +| logn | integer | any integer number | uninitialised | Log file number - declared in input module. | +| fixedCO2 | real | any real number | 350 | CO$_2$ concentration if not found in met file, in units ppmv. | +| spincasa | logical | .TRUE. .FALSE. | uninitialised | Spin CASA before running the model if TRUE, and should be set to FALSE if spincasainput is .TRUE.. | +| l_casacnp | logical | .TRUE. .FALSE. | .FALSE. | Use CASA-CNP with CABLE. | | l_landuse | logical | .TRUE. .FALSE. | .FALSE. | Use land-use change. | | l_laiFeedbk | logical | .TRUE. .FALSE. | .FALSE. | Use prognostic leaf area index. | -| l_vcmaxFeedbk | logical | .TRUE. .FALSE. | .FALSE. | Use prognostic Vcmax | +| l_vcmaxFeedbk | logical | .TRUE. .FALSE. | .FALSE. | Use prognostic Vcmax. | | CASAonly | logical | .TRUE. .FALSE. | .FALSE. | ONLY run CASA-CNP. | -| icycle | integer | 0, 1, 2, 3, >10 | 0 | 0 for not using casaCNP, 1 for C, 2 for C+N, 3 for C+N+P, >10 excludes call to CBM (main call to cable) | +| icycle | integer | 0, 1, 2, 3, >10 | 0 | 0 for not using CASA-CNP, 1 for C, 2 for C+N, 3 for C+N+P, >10 excludes call to CBM (main call to cable).| | casafile%cnpipool | character(len=99) | any string of max. 99 characters | '' | Initial CNP pool size file name. | | casafile%cnpbiome | character(len=99) | any string of max. 99 characters | uninitialised | Biome specific biogeochemical parameters file name. | | casafile%cnpepool | character(len=99) | any string of max. 99 characters | uninitialised | End of run pool size file name. | | casafile%cnpmetout | character(len=99) | any string of max. 99 characters | uninitialised | Output daily met forcing for spinning CASA-CNP file name. | | casafile%cnpmetin | character(len=99) | any string of max. 99 characters | uninitialised | List of daily met files for spinning CASA-CNP file name. | | casafile%phen | character(len=99) | any string of max. 99 characters | uninitialised | Modis phenology file name. | -| casafile%cnpflux | character(len=99) | any string of max. 99 characters | uninitialised | Output file name for CNP fluxes | +| casafile%cnpflux | character(len=99) | any string of max. 99 characters | uninitialised | Output file name for CNP fluxes. | | casafile%c2cdumppath | character(len=99) | any string of max. 99 characters | '' | CABLE to CASA dump for CASA spin up. | | ncciy | integer | any integer | uninitialised | GSWP year. 0 for not using GSWP; 4-digit year input for year of GSWP meteorological forcing. | | gswpfile%rainf | character(len=200) | any string of max. 200 characters | uninitialised | Input file for rain meteorological forcing. | @@ -153,12 +151,12 @@ applications. The following are annotated examples of cable.nml: | satuParam | real | any real | 0.0 | Saturation parameter in hydraulic redistribution module. | | cable_user%FWSOIL_SWITCH | character | 'standard' 'non-linear extrapolation' 'Lai and Ktaul 2000' | '' | Controls root water uptake function. | | cable_user%DIAG_SOIL_RESP | character(len=3) | 'ON' 'OFF' | '' | Controls soil respiration scheme when CASA-CNP not used. | -| cable_user%LEAF_RESPIRATION | character(len=3) | 'ON' 'OFF' | uninitialised | Controls what is output into the GPP stash variable. | +| cable_user%LEAF_RESPIRATION | character(len=3) | 'ON' 'OFF' | uninitialised | Controls what is output into the gross primary productivity stash variable. | | cable_user%RUN_DIAG_LEVEL | character(len=5) | 'BASIC' 'NONE' | uninitialised | Controls output from CABLE to standard out. | -| cable_user%CONSISTENCY_CHECK | logical | .TRUE. .FALSE. | .FALSE. | TRUE outputs combined fluxes at each timestep for comparison to a control run | -| cable_user%CASA_DUMP_READ | logical | .TRUE. .FALSE. | .FALSE. | TRUE reads CASA forcing from netcdf format | -| cable_user%CASA_DUMP_WRITE | logical | .TRUE. .FALSE. | .FALSE. | TRUE outputs CASA forcing in netcdf format | -| cable_user%SSNOW_POTEV | character(len=3) | 'HDM' 'P-M' | '' | Use the “Humidity Deficit Method” or “Penman-Monteith” method | +| cable_user%CONSISTENCY_CHECK | logical | .TRUE. .FALSE. | .FALSE. | TRUE outputs combined fluxes at each timestep for comparison to a control run. | +| cable_user%CASA_DUMP_READ | logical | .TRUE. .FALSE. | .FALSE. | TRUE reads CASA forcing from netcdf format. | +| cable_user%CASA_DUMP_WRITE | logical | .TRUE. .FALSE. | .FALSE. | TRUE outputs CASA forcing in netcdf format. | +| cable_user%SSNOW_POTEV | character(len=3) | 'HDM' 'P-M' | '' | Use the “Humidity Deficit Method” or “Penman-Monteith” method. | | cable_user%GS_SWITCH | character(len=20) | 'medlyn' 'leuning' | 'medlyn' | Stomatal conductance model. | | cable_user%l_revised_coupling | logical | .TRUE. .FALSE. | .FALSE. | Revised coupling on implicit step of ACCESS-CM2. | | cable_user%l_rev_corr | logical | .TRUE. .FALSE. | .FALSE. | Apply revised sensitvity/correction terms to soilsnow energy balance. | @@ -172,12 +170,12 @@ applications. The following are annotated examples of cable.nml: | cable_user%casa_out_freq | character(len=8) | 'daily' 'monthly' 'annually' | 'annually' | CASA output frequency. | | cable_user%vcmax | character(len=10) | 'standard' 'Walker2014' | 'standard' | Alternative functional form of $V_{cmax}$ (maximum RuBP carboxylation rate). For `'Walker2014'` see doi:10.1002/ece3.1173 . | | cable_user%POPLUC_RunType | character(len=10) | 'static' 'init' 'restart' | 'static' | Type of POP-LUC run. `'init'` is initial POP-LUC run, `'restart'` is a restart run, `'static'` disables dynamic vegetation and sets `cable_user%POPLUC = .FALSE.`.| -| cable_user%call_pop | logical | .TRUE. .FALSE. | .FALSE., | Enable POP. | -| cable_user%POP_fromZero | logical | .TRUE. .FALSE. | .FALSE., | Run POP initialisation. | -| cable_user%call_climate | logical | .TRUE. .FALSE. | .FALSE., | Track climate variables for use in phenology and potential plant functional type modules. | -| cable_user%climate_fromzero | logical | .TRUE. .FALSE. | .FALSE., | Initialise climate variables with 0. | -| cable_user%CASA_fromzero | logical | .TRUE. .FALSE. | .FALSE., | Initialize CASA from 0 without restart files. | -| cable_user%POPLUC | logical | .TRUE. .FALSE. | .FALSE., | Enable POP-LUC. | +| cable_user%call_pop | logical | .TRUE. .FALSE. | .FALSE. | Enable POP. | +| cable_user%POP_fromZero | logical | .TRUE. .FALSE. | .FALSE. | Run POP initialisation. | +| cable_user%call_climate | logical | .TRUE. .FALSE. | .FALSE. | Track climate variables for use in phenology and potential plant functional type modules. | +| cable_user%climate_fromzero | logical | .TRUE. .FALSE. | .FALSE. | Initialise climate variables with 0. | +| cable_user%CASA_fromzero | logical | .TRUE. .FALSE. | .FALSE. | Initialise CASA from 0 without restart files. | +| cable_user%POPLUC | logical | .TRUE. .FALSE. | .FALSE. | Enable POP-LUC. | | cable_user%casa_spin_startyear | integer | any integer | 1950 | CASA spinup start year. | | cable_user%casa_spin_endyear | integer | any integer | 1960 | CASA spinup end year. | | cable_user%yearstart | integer | any integer | 0 | Start year of run. | @@ -185,22 +183,21 @@ applications. The following are annotated examples of cable.nml: | cable_user%casa_nrep | integer | any integer | 1 | Number of repetitions of CASA spinup. | | cable_user%smrf_name | character(len=10) | 'CASA-CNP' 'SOILN' 'TRIFFID' | uninitialised | Soil moisture respiration function. | | cable_user%strf_name | character(len=10) | 'CASA-CNP' 'SOILN' 'TRIFFID' | uninitialised | Soil temperature respiration function. | -| cable_user%LogWorker | logical | .TRUE. .FALSE. | .TRUE., | Write output of each worker | -| cable_user%l_new_roughness_soil | logical | .TRUE. .FALSE. | .FALSE., | Use alternative roughness and flux resistance scheme. | -| cable_user%l_new_runoff_speed | logical | .TRUE. .FALSE. | .FALSE., | Use alternative soil water drainage scheme. | -| cable_user%l_new_reduce_soilevp | logical | .TRUE. .FALSE. | .FALSE., | Use alternative soil evaporation scheme. | -| cable_user%srf | logical | .TRUE. .FALSE. | .FALSE., | Switch for customized soil respiration | -| cable_user%litter | logical | .TRUE. .FALSE. | .FALSE., | ? | -| cable_user%gw_model | logical | .TRUE. .FALSE. | .FALSE., | ? | -| cable_user%gswp3 | logical | .TRUE. .FALSE. | .FALSE., | Use GSWP3 forcing. | -| cable_user%or_evap | logical | .TRUE. .FALSE. | .FALSE., | ? | -| cable_user%test_new_gw | logical | .TRUE. .FALSE. | .FALSE., | ? | -| cable_user%sync_nc_file | logical | .TRUE. .FALSE. | .FALSE., | Write netCDF output to file without closing during run. | +| cable_user%LogWorker | logical | .TRUE. .FALSE. | .TRUE. | Write output of each worker. | +| cable_user%l_new_roughness_soil | logical | .TRUE. .FALSE. | .FALSE. | Use alternative roughness and flux resistance scheme. | +| cable_user%l_new_runoff_speed | logical | .TRUE. .FALSE. | .FALSE. | Use alternative soil water drainage scheme. | +| cable_user%l_new_reduce_soilevp | logical | .TRUE. .FALSE. | .FALSE. | Use alternative soil evaporation scheme. | +| cable_user%srf | logical | .TRUE. .FALSE. | .FALSE. | Switch for customized soil respiration. | +| cable_user%litter | logical | .TRUE. .FALSE. | .FALSE. | Add litter layer on top of the soil surface. | +| cable_user%gw_model | logical | .TRUE. .FALSE. | .FALSE. | Enable alternate soil model that accounts for groundwater. | +| cable_user%gswp3 | logical | .TRUE. .FALSE. | .FALSE. | Use GSWP3 forcing. | +| cable_user%or_evap | logical | .TRUE. .FALSE. | .FALSE. | Enable Dani Or's evaporation scheme. | +| cable_user%sync_nc_file | logical | .TRUE. .FALSE. | .FALSE. | Write netCDF output to file without closing during run. | | cable_user%max_spins | integer | any integer | 1 | Maximum number of iterations for a spinup. CABLE will act as if convergence has been reached after max_spins iterations even if it was not reached. | -| cable_user%fix_access_roots | logical | .TRUE. .FALSE. | .FALSE., | Use pft dependent roots in ACCESS | -| cable_user%access13roots | logical | .TRUE. .FALSE. | .FALSE., | Switch to use ACCESS1.3 %froot. | -| cable_user%l_limit_labile | logical | .TRUE. .FALSE. | .FALSE., | Limit Labile in spinup | -| cable_user%NtilesThruMetFile | logical | .TRUE. .FALSE. | .FALSE., | Specify Ntiles through met file | +| cable_user%fix_access_roots | logical | .TRUE. .FALSE. | .FALSE. | Use plant functional type dependent roots in ACCESS | +| cable_user%access13roots | logical | .TRUE. .FALSE. | .FALSE. | Switch to use ACCESS1.3 %froot. | +| cable_user%l_limit_labile | logical | .TRUE. .FALSE. | .FALSE. | Limit labile in spinup. | +| cable_user%NtilesThruMetFile | logical | .TRUE. .FALSE. | .FALSE. | Specify Ntiles through met file. | ## For ACCESS applications ## From 3b65980b6bafcbffd73a9a2ec825525a3d66af2b Mon Sep 17 00:00:00 2001 From: Tammas Loughran Date: Fri, 15 Sep 2023 14:12:39 +1000 Subject: [PATCH 11/13] Apply suggestions from code review Co-authored-by: Claire Carouge --- documentation/docs/user_guide/inputs/cable_nml.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/documentation/docs/user_guide/inputs/cable_nml.md b/documentation/docs/user_guide/inputs/cable_nml.md index 06368cd66..4794bc1b4 100644 --- a/documentation/docs/user_guide/inputs/cable_nml.md +++ b/documentation/docs/user_guide/inputs/cable_nml.md @@ -83,6 +83,8 @@ applications. The following are annotated examples of cable.nml: &end ``` +## List of namelist variables + | Namelist variable | Type | Available values | Default value | Description | |----------------------------------|--------------------|------------------------------------------------------------|----------------------------------|---------------------------------------------------------------------------------------------------------| | filename%met | character(len=500) | any string of max. 500 characters | uninitialised | Meteorological forcing file name. | @@ -93,7 +95,7 @@ applications. The following are annotated examples of cable.nml: | 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%soilcolor | character(len=500) | any string of max. 500 characters | uninitialised | Soil color file name. E.g. "CABLE-AUX/offline/soilcolor_global_1x1.nc" | | 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 | Plant functional type fraction, wood harvest and secondary harvest file. | | 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. | @@ -105,7 +107,7 @@ applications. The following are annotated examples of cable.nml: | delsoilT | real | any real number | uninitialised | Allowed variation in soil temperature for spin up. | | output%restart | logical | .TRUE. .FALSE. | uninitialised | Create a restart file when .TRUE.. | | output%met | logical | .TRUE. .FALSE. | .FALSE. | Output input meteorological data when .TRUE.. | -| output%flux | logical | .TRUE. .FALSE. | .FALSE. | Output convective, runoff, NEE. | +| output%flux | logical | .TRUE. .FALSE. | .FALSE. | Output convective, runoff, NEE when TRUE | | output%soil | logical | .TRUE. .FALSE. | .FALSE. | Output soil states when .TRUE.. | | output%snow | logical | .TRUE. .FALSE. | .FALSE. | Output snow states when .TRUE.. | | output%radiation | logical | .TRUE. .FALSE. | .FALSE. | Output Net radiation and albedo when .TRUE.. | @@ -168,7 +170,7 @@ applications. The following are annotated examples of cable.nml: | cable_user%POP_out | character(len=3) | 'epi' 'rst' 'ini' | 'rst' | POP restart file type. `'epi'` is end of year state `'rst'` is a standard restart file, `'ini'` is an initialisation restart file. | | cable_user%POP_rst | character(len=50) | any string of max. 50 characters | ' ' | POP restart file directory. | | cable_user%casa_out_freq | character(len=8) | 'daily' 'monthly' 'annually' | 'annually' | CASA output frequency. | -| cable_user%vcmax | character(len=10) | 'standard' 'Walker2014' | 'standard' | Alternative functional form of $V_{cmax}$ (maximum RuBP carboxylation rate). For `'Walker2014'` see doi:10.1002/ece3.1173 . | +| cable_user%vcmax | character(len=10) | 'standard' 'Walker2014' | 'standard' | Alternative functional form of $V_{cmax}$ (maximum RuBP carboxylation rate). For `'Walker2014'` see [Walker et al., 2014](https://doi.org/10.1002/ece3.1173) | | cable_user%POPLUC_RunType | character(len=10) | 'static' 'init' 'restart' | 'static' | Type of POP-LUC run. `'init'` is initial POP-LUC run, `'restart'` is a restart run, `'static'` disables dynamic vegetation and sets `cable_user%POPLUC = .FALSE.`.| | cable_user%call_pop | logical | .TRUE. .FALSE. | .FALSE. | Enable POP. | | cable_user%POP_fromZero | logical | .TRUE. .FALSE. | .FALSE. | Run POP initialisation. | From 32855e472c846e83b18940cc071c41ec7523d769 Mon Sep 17 00:00:00 2001 From: Tammas Loughran Date: Fri, 15 Sep 2023 14:48:46 +1000 Subject: [PATCH 12/13] Moved table to the top and the example files to the bottom. --- .../docs/user_guide/inputs/cable_nml.md | 136 +++++++++--------- 1 file changed, 68 insertions(+), 68 deletions(-) diff --git a/documentation/docs/user_guide/inputs/cable_nml.md b/documentation/docs/user_guide/inputs/cable_nml.md index 4794bc1b4..aa64fac39 100644 --- a/documentation/docs/user_guide/inputs/cable_nml.md +++ b/documentation/docs/user_guide/inputs/cable_nml.md @@ -16,73 +16,6 @@ applications. The following are annotated examples of cable.nml: [obsolete and deprecated user features](../obsolete_and_deprecated_features/obsolete_and_deprecated_features.md) page. -## For offline applications ## - -```fortran -&cable - filename%met = '/projects/access/CABLE-AUX/offline/TumbaFluxnet.1.3_met.nc' - filename%out = 'out_cable.nc' - filename%log = 'log_cable.txt' - filename%restart_in = ' ' - filename%restart_out = './restart_out.nc' - filename%type = '/projects/access/CABLE-AUX/offline/gridinfo_CSIRO_1x1.nc' - vegparmnew = .TRUE. ! using new format when true - soilparmnew = .TRUE. ! using new format when true - spinup = .TRUE. ! do we spin up the model? - delsoilM = 0.001 ! allowed variation in soil moisture for spin up - delsoilT = 0.01 ! allowed variation in soil temperature for spin up - output%restart = .TRUE. ! should a restart file be created? - output%met = .TRUE. ! input met data - output%flux = .TRUE. ! convective, runoff, NEE - output%soil = .TRUE. ! soil states - output%snow = .TRUE. ! snow states - output%radiation = .TRUE. ! net rad, albedo - output%carbon = .TRUE. ! NEE, GPP, NPP, stores - output%veg = .TRUE. ! vegetation states - output%params = .TRUE. ! input parameters used to produce run - output%balances = .TRUE. ! energy and water balances - check%ranges = .FALSE. ! variable ranges, input and output - 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 - 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. - l_casacnp = .FALSE. ! using casaCNP with CABLE - l_laiFeedbk = .FALSE. ! using prognostic LAI - l_vcmaxFeedbk = .FALSE. ! using prognostic Vcmax - icycle = 0 ! BP pull it out from casadimension and put here; 0 for not using casaCNP, 1 for C, 2 for C+N, 3 for C+N+P - casafile%cnpipool='/projects/access/CABLE-AUX/core/biogeochem/poolcnpInTumbarumba.csv' ! - casafile%cnpbiome='/projects/access/CABLE-AUX/core/biogeochem/pftlookup_csiro_v16_17tiles.csv' ! biome specific BGC parameters - casafile%cnpepool='poolcnpOut.csv' ! end of run pool size - casafile%cnpmetout='casamet.nc' ! output daily met forcing for spinning casacnp - casafile%cnpmetin='' ! list of daily met files for spinning casacnp - casafile%phen='/projects/access/CABLE-AUX/core/biogeochem/modis_phenology_csiro.txt' ! modis phenology - casafile%cnpflux='cnpfluxOut.csv' - ncciy = 0 ! 0 for not using gswp; 4-digit year input for year of gswp met - gswpfile%rainf = 'gswp/Rainf_gswp1987.nc' - gswpfile%snowf = 'gswp/Snowf_gswp1987.nc' - gswpfile%LWdown= 'gswp/LWdown_srb1987.nc' - gswpfile%SWdown= 'gswp/SWdown_srb1987.nc' - gswpfile%PSurf = 'gswp/PSurf_ecor1987.nc' - gswpfile%Qair = 'gswp/Qair_cru1987.nc' - gswpfile%Tair = 'gswp/Tair_cru1987.nc' - gswpfile%wind = 'gswp/Wind_ncep1987.nc' - redistrb = .FALSE. ! Turn on/off the hydraulic redistribution - wiltParam = 0.5 - satuParam = 0.8 - cable_user%FWSOIL_SWITCH = 'standard' ! choices are: 'standard', 'non-linear extrapolation' or 'Lai and Ktaul 2000' - cable_user%DIAG_SOIL_RESP = 'ON ' - cable_user%LEAF_RESPIRATION = 'ON ' - cable_user%RUN_DIAG_LEVEL= 'BASIC' ! choices are: 'BASIC', 'NONE' - cable_user%CONSISTENCY_CHECK= .TRUE. ! TRUE outputs combined fluxes at each timestep for comparison to a control run - cable_user%CASA_DUMP_READ = .FALSE. ! TRUE reads CASA forcing from netcdf format - cable_user%CASA_DUMP_WRITE = .FALSE. ! TRUE outputs CASA forcing in netcdf format - cable_user%SSNOW_POTEV= 'HDM' ! Humidity Deficit Method -&end -``` - ## List of namelist variables | Namelist variable | Type | Available values | Default value | Description | @@ -170,7 +103,7 @@ applications. The following are annotated examples of cable.nml: | cable_user%POP_out | character(len=3) | 'epi' 'rst' 'ini' | 'rst' | POP restart file type. `'epi'` is end of year state `'rst'` is a standard restart file, `'ini'` is an initialisation restart file. | | cable_user%POP_rst | character(len=50) | any string of max. 50 characters | ' ' | POP restart file directory. | | cable_user%casa_out_freq | character(len=8) | 'daily' 'monthly' 'annually' | 'annually' | CASA output frequency. | -| cable_user%vcmax | character(len=10) | 'standard' 'Walker2014' | 'standard' | Alternative functional form of $V_{cmax}$ (maximum RuBP carboxylation rate). For `'Walker2014'` see [Walker et al., 2014](https://doi.org/10.1002/ece3.1173) | +| cable_user%vcmax | character(len=10) | 'standard' 'Walker2014' | 'standard' | Alternative functional form of $V_{cmax}$ (maximum RuBP carboxylation rate). For `'Walker2014'` see [Walker et al., 2014](https://onlinelibrary.wiley.com/doi/10.1002/ece3.1173) | | cable_user%POPLUC_RunType | character(len=10) | 'static' 'init' 'restart' | 'static' | Type of POP-LUC run. `'init'` is initial POP-LUC run, `'restart'` is a restart run, `'static'` disables dynamic vegetation and sets `cable_user%POPLUC = .FALSE.`.| | cable_user%call_pop | logical | .TRUE. .FALSE. | .FALSE. | Enable POP. | | cable_user%POP_fromZero | logical | .TRUE. .FALSE. | .FALSE. | Run POP initialisation. | @@ -202,6 +135,73 @@ applications. The following are annotated examples of cable.nml: | cable_user%NtilesThruMetFile | logical | .TRUE. .FALSE. | .FALSE. | Specify Ntiles through met file. | +## For offline applications ## + +```fortran +&cable + filename%met = '/projects/access/CABLE-AUX/offline/TumbaFluxnet.1.3_met.nc' + filename%out = 'out_cable.nc' + filename%log = 'log_cable.txt' + filename%restart_in = ' ' + filename%restart_out = './restart_out.nc' + filename%type = '/projects/access/CABLE-AUX/offline/gridinfo_CSIRO_1x1.nc' + vegparmnew = .TRUE. ! using new format when true + soilparmnew = .TRUE. ! using new format when true + spinup = .TRUE. ! do we spin up the model? + delsoilM = 0.001 ! allowed variation in soil moisture for spin up + delsoilT = 0.01 ! allowed variation in soil temperature for spin up + output%restart = .TRUE. ! should a restart file be created? + output%met = .TRUE. ! input met data + output%flux = .TRUE. ! convective, runoff, NEE + output%soil = .TRUE. ! soil states + output%snow = .TRUE. ! snow states + output%radiation = .TRUE. ! net rad, albedo + output%carbon = .TRUE. ! NEE, GPP, NPP, stores + output%veg = .TRUE. ! vegetation states + output%params = .TRUE. ! input parameters used to produce run + output%balances = .TRUE. ! energy and water balances + check%ranges = .FALSE. ! variable ranges, input and output + 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 + 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. + l_casacnp = .FALSE. ! using casaCNP with CABLE + l_laiFeedbk = .FALSE. ! using prognostic LAI + l_vcmaxFeedbk = .FALSE. ! using prognostic Vcmax + icycle = 0 ! BP pull it out from casadimension and put here; 0 for not using casaCNP, 1 for C, 2 for C+N, 3 for C+N+P + casafile%cnpipool='/projects/access/CABLE-AUX/core/biogeochem/poolcnpInTumbarumba.csv' ! + casafile%cnpbiome='/projects/access/CABLE-AUX/core/biogeochem/pftlookup_csiro_v16_17tiles.csv' ! biome specific BGC parameters + casafile%cnpepool='poolcnpOut.csv' ! end of run pool size + casafile%cnpmetout='casamet.nc' ! output daily met forcing for spinning casacnp + casafile%cnpmetin='' ! list of daily met files for spinning casacnp + casafile%phen='/projects/access/CABLE-AUX/core/biogeochem/modis_phenology_csiro.txt' ! modis phenology + casafile%cnpflux='cnpfluxOut.csv' + ncciy = 0 ! 0 for not using gswp; 4-digit year input for year of gswp met + gswpfile%rainf = 'gswp/Rainf_gswp1987.nc' + gswpfile%snowf = 'gswp/Snowf_gswp1987.nc' + gswpfile%LWdown= 'gswp/LWdown_srb1987.nc' + gswpfile%SWdown= 'gswp/SWdown_srb1987.nc' + gswpfile%PSurf = 'gswp/PSurf_ecor1987.nc' + gswpfile%Qair = 'gswp/Qair_cru1987.nc' + gswpfile%Tair = 'gswp/Tair_cru1987.nc' + gswpfile%wind = 'gswp/Wind_ncep1987.nc' + redistrb = .FALSE. ! Turn on/off the hydraulic redistribution + wiltParam = 0.5 + satuParam = 0.8 + cable_user%FWSOIL_SWITCH = 'standard' ! choices are: 'standard', 'non-linear extrapolation' or 'Lai and Ktaul 2000' + cable_user%DIAG_SOIL_RESP = 'ON ' + cable_user%LEAF_RESPIRATION = 'ON ' + cable_user%RUN_DIAG_LEVEL= 'BASIC' ! choices are: 'BASIC', 'NONE' + cable_user%CONSISTENCY_CHECK= .TRUE. ! TRUE outputs combined fluxes at each timestep for comparison to a control run + cable_user%CASA_DUMP_READ = .FALSE. ! TRUE reads CASA forcing from netcdf format + cable_user%CASA_DUMP_WRITE = .FALSE. ! TRUE outputs CASA forcing in netcdf format + cable_user%SSNOW_POTEV= 'HDM' ! Humidity Deficit Method +&end +``` + ## For ACCESS applications ## From c53f9bb548e0076dedaead8f26907c5799b8121e Mon Sep 17 00:00:00 2001 From: Claire Carouge Date: Fri, 15 Sep 2023 18:59:47 +1000 Subject: [PATCH 13/13] This link returns a 403 error in the check but is actually a valid link --- documentation/docs/user_guide/inputs/cable_nml.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/documentation/docs/user_guide/inputs/cable_nml.md b/documentation/docs/user_guide/inputs/cable_nml.md index aa64fac39..dbe07c6f7 100644 --- a/documentation/docs/user_guide/inputs/cable_nml.md +++ b/documentation/docs/user_guide/inputs/cable_nml.md @@ -103,7 +103,7 @@ applications. The following are annotated examples of cable.nml: | cable_user%POP_out | character(len=3) | 'epi' 'rst' 'ini' | 'rst' | POP restart file type. `'epi'` is end of year state `'rst'` is a standard restart file, `'ini'` is an initialisation restart file. | | cable_user%POP_rst | character(len=50) | any string of max. 50 characters | ' ' | POP restart file directory. | | cable_user%casa_out_freq | character(len=8) | 'daily' 'monthly' 'annually' | 'annually' | CASA output frequency. | -| cable_user%vcmax | character(len=10) | 'standard' 'Walker2014' | 'standard' | Alternative functional form of $V_{cmax}$ (maximum RuBP carboxylation rate). For `'Walker2014'` see [Walker et al., 2014](https://onlinelibrary.wiley.com/doi/10.1002/ece3.1173) | +| cable_user%vcmax | character(len=10) | 'standard' 'Walker2014' | 'standard' | Alternative functional form of $V_{cmax}$ (maximum RuBP carboxylation rate). For `'Walker2014'` see [Walker et al., 2014][Walker] | | cable_user%POPLUC_RunType | character(len=10) | 'static' 'init' 'restart' | 'static' | Type of POP-LUC run. `'init'` is initial POP-LUC run, `'restart'` is a restart run, `'static'` disables dynamic vegetation and sets `cable_user%POPLUC = .FALSE.`.| | cable_user%call_pop | logical | .TRUE. .FALSE. | .FALSE. | Enable POP. | | cable_user%POP_fromZero | logical | .TRUE. .FALSE. | .FALSE. | Run POP initialisation. | @@ -279,3 +279,5 @@ applications. The following are annotated examples of cable.nml: casafile%phen='~/CABLE-AUX/core/biogeochem/modis_phenology_csiro.txt' ! phenology by latitude (modis derived) &end ``` + + [Walker]: https://doi.org/10.1002/ece3.1173 \ No newline at end of file