Land Model Diagnostics Package
lnd_diag v4.1
1. Introduction: Lnd_diag v4.1
Background:
Lnd_diag4.1 was redesigned from earlier land diagnostic packages (v2 and v3). Lnd_diag v4 differs from previous versions in the fundamental way that it defines ON and OFF: lnd_diag2 and lnd_diag3 scripts use 0 to turn ON actions; lnd_diag4.* uses 0 to turn OFF actions. The lnd_diag v4 pre-processing logic facilitates analysis of long climatological runs which have prohibitively large space requirements. Version 4 now enables paleo-climate reconstructions for all analyses. Version 4 produces bit-for-bit consistency with v2 and v3 and the resulting analyses are identical. However, lnd_diag v4 run scripts are not backward compatible with earlier versions.
1.a. Pre-processing Changes:
- The new logic computes long-term averages as a continuous computation for the climatology period by maintaining a running summation across the period. This process eliminates the need to keep monthly history files available locally until all MSS files have been retrieved. Resulting climatological files are bit-for-bit with earlier versions.
- The new logic allows optional restarting options:
- Section 8a: script option =
restart. Restart pre-processing that fails mid-stream (e.g., the machine goes down after year 89 of a 100 year climatology run) without losing data processed up to the point of failure (in this case from year 88). - Section 8b: script option =
branch. Pre-processing can extend a previous analysis. E.g., Run 1 estimates climatology for years 1-150. Run 2 can continue this climatology from years 1-250 without re-running years 1-150. The script automatically copies the old summary files to the new working directory, renaming them appropriately. - Section 15: script option =
branch. Restart the analysis package after a specific set. This option allows you to resume analysis after a set failure without having to rerun successfully completed sets.
- Section 8a: script option =
- Preprocessing is done in one step (
lnd_preProcess.pl). - Program computes long-term climatology continuously without saving monthly history files. Each year is processed into annual files, and the monthly files are compiled in continuous monthly and seasonal files for the long-term climatology. To save space, the monthly history files are removed after they are processed (script option:
rmMonFilesTrend,rmMonFilesClimo).
1.b. Download lnd_diag4.1:
1.c. Revision history:
- Version 4.1 addition of
levgrnd, with backward compatibility withlevsoi.
1.d. Required and recommended software:
| Software | Description |
|---|---|
| NCL | The NCAR Command Language (NCL), a product of the Computational & Information Systems Laboratory at the National Center for Atmospheric Research (NCAR) and sponsored by the National Science Foundation, is a free interpreted language designed specifically for scientific data processing and visualization. |
| NCO | The netCDF Operators, or NCO, are a suite of programs known as operators. Each operator is a standalone, command line program which is executed at the UNIX shell-level. The operators take netCDF files as input, then perform a set of operations (e.g., deriving new data, averaging, hyperslabbing, or metadata manipulation) and produce a netCDF file as output. The operators are primarily designed to aid manipulation and analysis of gridded scientific data. |
| ImageMagick | ImageMagick software is used to convert postscript output files to GIF formatted images. |
| ncview (optional) | Ncview is a visual browser for netCDF format files. Ncview is not an analysis package; its purpose in life is to quickly and easily view simple plots of data stored in netCDF format. |
2. Run Script Documentation
NOTE: If you wish to stop (i.e., kill) an analysis run during the pre-processing phase where the summary files are being created you will need to first put the process into the background:
- Interrupt the script by typing:
cntrl^Z - Put the process into the background by typing: ‘
bg’ - Get the process ID by typing: ‘
jobs’ - Kill the process by typing: ‘
kill -9 %<process_id>’
Run Script Template:
| Version | Run script template | Code source |
|---|---|---|
| lnd_diag4.1 | lnd_template4.*.csh | CISL: /fis/cgd/tss/diag/lnd_diag4.1 CGD: /project/tss/diag/lnd_diag4.1 |
Section 1: Data Path
| Environment Variable | Default Setting | Description |
|---|---|---|
| PTMPDIR | CISL: /ptmp/$LOGNAME CGD: /scratch/$LOGNAME |
Working directory |
| SOURCE_1 | CISL: /ptmp/$LOGNAME CGD: /scratch/$LOGNAME |
File source 1 |
| SOURCE_2 | /ptmp/USER2 | File source 2 |
| LOCAL_FLAG_1 | 0 | look for history files in LOCAL_1 |
| LOCAL_FLAG_2 | 0 | look for history files in LOCAL_2 |
| LOCAL_FLAG_atm_1 | 0 | look for history files in LOCAL_1 |
| LOCAL_FLAG_atm_2 | 0 | look for history files in LOCAL_2 |
| LOCAL_LN | 1 | 1=create soft link; 0=copy files |
Section 2: Source Path
NCAR users should not need to change DIAG_HOME unless you wish to point to a local version of the land diagnostics package (e.g., to make code modifications). Note that even if DIAG_HOME points to your personal sandbox, OBS_HOME can still point to the default OBS_HOME directory to save file space (the OBS_HOME directory is large).
| Environment Variable | Default Setting | Description |
|---|---|---|
| DIAG_HOME | CISL: /fis/cgd/tss/diag/lnd_diag4.1 CGD: /project/tss/diag/lnd_diag4.1 |
NCAR source directory maintained by LMWG |
| OBS_HOME | CISL: /fis/cgd/tss/diag/lnd_diag4.1 CGD: /project/tss/diag/lnd_diag4.1 |
NCAR source directory maintained by LMWG |
Section 3: Variable Lists
Do not change INPUT_HOME unless you wish to copy the contents of this directory to a personal workspace to create non-standard variable lists for sets 1, 2 5, or 8. Note that changing the variables analyzed in sets 3, 4, 6, and 7 requires considerable code revision.
To create non-standard variable lists for sets 1, 2, 5, and 8:
- copy all variable lists from
$INPUT_HOME/inputFiles - modify variable lists (original format is required – Appendix A)
- Change
INPUT_HOMEto point to new variable lists.
| Environment Variable | Default Setting | Description |
|---|---|---|
| INPUT_HOME | /${DIAG_HOME}/lnd_diag4.1/code | Source lists maintained by LMWG |
| var_master_cn | Variable_master4.2.ncl | Current master variable list |
Section 4: Type of Model Analysis
| Environment Variable | Default Setting | Description |
|---|---|---|
| OBS | 0 | Model1 (vs Obs where avail) |
| ModelVsModel | 1 | Model1 vs Model 2 (vs Obs where avail) |
Section 5: Run Identification
| Environment Variable | Default Setting | Description (0=ON;1=OFF) |
|---|---|---|
| prefix_1 | clm3_6_14_newfrc_1995-2005 | Name of output directory where analysis is performed. The prefix name differentiates a particular diagnostic from others within a series with the same case name. Convention uses the analysis years to distinguish the run (e.g., clm3_6_14_newfrc_1948-2004) |
| caseid_1 | clm3_6_14_newfrc | History file name (case1). This name identifies the history files on the MSS |
| commonName_1 | test | Descriptive name for plotting (optional) |
| UseCommonName_1 | 0 | Use commonName for plots instead of caseid (optional). |
| prefix_2 | clm4_1995-2005 | output file and directory name (case2) |
| caseid_2 | clm4 | history file and MSS name (case2) |
| commonName_1 | control | Descriptive name for plotting (optional) (case2) |
| UseCommonName_2 | 0 | Use commonName for plots instead of caseid (optional). |
Section 6a: MSS Paths
| Environment Variable | Default Setting | Description |
|---|---|---|
| MSS_tarfile_1 | 0 | 1=MSS annual tar files. 0=MSS monthly history files. |
| MSS_tarfile_2 | 1 | 1=MSS annual tar files. 0=MSS monthly history files. |
| MSS_path_1 | /OLESON/csm/${caseid_1}/lnd/hist | Mass Storage System Path |
| MSS_path_2 | /OLESON/csm/${caseid_1}/lnd/hist | Mass Storage System Path |
| MSS_path_atm_1 | /OLESON/csm/${caseid_1}/atm/hist | Mass Storage System Path |
| MSS_path_atm_2 | /OLESON/csm/${caseid_1}/atm/hist | Mass Storage System Path |
Section 6b: Local Path
| Environment Variable | Default Setting | Description (0=ON; 1=OFF) |
|---|---|---|
| LOCAL_1 | /ptmp/${USER}/${caseid_1}/ | Local file Path |
| LOCAL_2 | /ptmp/${USER}/${caseid_1}/ | Local file Path |
| LOCAL_atm_1 | /ptmp/${USER}/${caseid_1}/atm/ | Local file Path |
| LOCAL_atm_2 | /ptmp/${USER}/${caseid_1}/atm/ | Local file Path |
Section 6c: MSS storage path
| Environment Variable | Default Setting | Description |
|---|---|---|
| MSS_write | 0 | Write tar and summary files to MSS |
| MSS_pe | 365 | Retention period |
| MSS_proj | 00000000 | Project charged for MSS storage |
| Write2MSS_Only | 0 | Write MSS files ONLY (assumes processing is complete) |
| MSS_path_out1 | /${UPPERCASE_USER}/csm/${caseid_1}/lnd/diag | MSS storage location for output |
| MSS_path_out2 | /${UPPERCASE_USER}/csm/${caseid_2}/lnd/diag | MSS storage location for output |
Section 7a: Summary File Processing
Post-process MSS files into summary files. This section activates the post-processing of CCSM history files into the summary files required by the diagnostics package. The diagnostics package will fail if these files do not exist. Note that there is a significant efficiency penalty for recreating the summary files if they already exist. See Appendix for description of summary file requirements.
| Environment Variable | Default Setting | Description |
|---|---|---|
| overWriteTrend | 1 | overwrite pre-existing trend files (ANN_ALL.nc) |
| overWriteClimo | 1 | overwrite pre-existing climo files (DJF_climo.nc etc.) |
| weightAnnAvg | 1 | ON: Ann=(Jan*31+Feb*28+…+Dec*31)/365 OFF: Ann=(Jan +Feb +…+Dec)/12 |
| CASE 1 | ||
| trends_1 | 1 | construct long-term trends for case 1 |
| climo_1 | 1 | construct climatological means for case 1 |
| trends_atm_1 | 0 | construct long-term atmospheric trends for case 1 |
| climo_atm_1 | 0 | construct climatological atmospheric means for case 1 |
| CASE 2 | ||
| trends_2 | 1 | construct long-term trends for case 2 |
| climo_2 | 1 | construct climatological means for case 2 |
| trends_atm_2 | 0 | construct long-term atmospheric trends for case 2 |
| climo_atm_2 | 0 | construct climatological atmospheric means for case 2 |
Section 7b: Seasonal Means Processing
Create seasonal means which are used for T-Test in set 2.
| Environment Variable | Default Setting | Description |
|---|---|---|
| meansFlag | 1 | for OBS runs |
| meansFlag | 1 | Required for set 2 T-Test for ModelVsModel runs. |
Section 8a: Restart Option
Use this optional flag to restart a run that failed during the pre-processing of CCSM history files into summary files. To restart a run:
- Set restart to 1
cd $PTMPDIR/$prefix_1- Determine the last year processed by looking for (
*_511-560.nc). The first number (511) is the first year in the climatology trends. The second number (560) was the last year processed before the interruption. - Set the
restartYrflag to the year before the last year processed (559). Using year 559 ensures usage of a complete year in case the processing interrupted the creation of year 560.
| Environment Variable | Default Setting | Description |
|---|---|---|
| Restart | 0 | restart trend and/climo calculation |
Section 8b: Branch Option (INACTIVE)
Extend the analysis of an existing case, or from a case processed under a different prefix name. The climatology period must start at the same year. <branch_prefix>/proc pre-processed sumFiles, monFiles and seasonal files from the previous run must already exist.
Note: Branching runs MUST share the same starting year (climo_first_yr).
| Environment Variable | Settings | Settings (1=On; 0=Off) |
|---|---|---|
| branch | 1 | Default=0: continue trends/climo from previous analysis |
| branch_fyr_1 | 1949 | First year of previous analysis (case 1) |
| branch_fyr_2 | 1949 | First year of previous analysis (case 2) |
| branch_lyr_1 | 1952 | Last year of previous analysis (case 1) |
| branch_lyr_2 | 1952 | Last year of previous analysis (case 2) |
| branch_prefix_1 | newcn05_ncep_1a | Prefix of previous analysis (case 1) |
| branch_prefix_2 | newcn05_ncep_2a | Prefix of previous analysis (case 2) |
| Branch_path_1 | /ptmp/$LOGNAME/diag | Working directory for previous analysis (case 1) |
| Branch_path_2 | /ptmp/$LOGNAME/diag | Working directory for previous analysis (case 2) |
Section 9: Monthly, Seasonal and Annual Climatology.
Specify first year and number of years to be analyzed for long-term climatologies. The ending year is calculated from clim_first_yr + clim_num_yrs. Model1 vs Model2 climatologies can compare different time periods, but for consistency they should be averaged over the same number of years.
| Setting | Description |
|---|---|
| clim_first_yr_1 clim_first_yr_2 |
First model year for calculating model climatology. |
| clim_num_yrs_1 clim_num_yrs_2 |
Number of years to be included in climatology. |
Example:
| Environment Variable | Settings |
|---|---|
| clim_first_yr_1 | 2000 |
| clim_num_yrs_1 | 5 |
| clim_first_yr_2 | 2000 |
| clim_num_yrs_1 | 5 |
Section 10a: Annual trends.
User-specified first year and number of years to be analyzed for long-term trends. The ending year is calculated from trends_first_yr + trends_num_yrs. Model1 vs Model2 trends can compare different time periods, and be of different lengths. For comparisons between runs of different lengths and/or time periods, use Section 9b to indicate the first year of overlap for each case.
| Setting | Description |
|---|---|
| trends_first_yr_1 trends_first_yr_2 |
First model year for calculating annual trends |
| trends_num_yrs_1 trends_num_yrs_2 |
Number of years to be included in annual trend analysis |
Example:
| Environment Variable | Settings |
|---|---|
| trends_first_yr_1 | 1995 |
| trends_num_yrs_1 | 10 |
| trends_first_yr_2 | 1995 |
| trends_num_yrs_1 | 10 |
Section 10b: Set Comparison Years (Optional)
Use this section to specify the first year of overlap between cases 1 and 2 if the length and/or time periods differ between cases.
| Environment Variable | Default Setting | Description |
|---|---|---|
| trends_match_Flag | 0 | 1=Turn on overlapping time periods |
| trends_match_yr_1 | 1975 | Identify first year of overlap for case 1 |
| trends_match_yr_2 | 1995 | Identify first year of overlap for case 2 |
Examples:
1) 100-179 vs 400-479
trends_match_Flag 1
trends_match_yr_1 100
trends_match_yr_2 400
Result: overlaps the two 80 yr periods
2) 100-179 vs 400-479
trends_match_Flag 1
trends_match_yr_1 170
trends_match_yr_2 400
Result: overlaps the last ten years of case 1 with the first 10 yrs of case 2.
3) 100-179 vs 100-179
trends_match_Flag 1
trends_match_yr_1 170
trends_match_yr_2 100
Result: overlaps the last ten years of case 1 with the first 10 yrs of case 2.
4) 100-179 vs 100-179
trends_match_Flag 1
trends_match_yr_1 170
trends_match_yr_2 150
Result: overlaps the last ten years of case 1 with the last 30 yrs of case 2.
Section 11: Optional Exit
Exit after reading MSS files and estimating trends and climatologies.
| Environment Variable | Default Setting | Description |
|---|---|---|
| Exit_after_MSS | 0 | Exit after downloading history files and calculating trends and climotologies. |
Section 12a: Carbon Models
| Environment Variable | Default Setting | Description |
|---|---|---|
| CN | 0 | CN carbon model active |
| C13 | 0 | C13 Carbon variables active (INACTIVE) |
| CLAMP | 0 | CLAMP variable terminology (INACTIVE) |
| CASA | 0 | CASA variable terminology (INACTIVE) |
Section 12b: Hydrology Variables
| Environment Variable | Default Setting | Description |
|---|---|---|
| HYDRO | 1 | Hydrology plots active |
Section 13: NaN Screening (Optional)
Pre-screen for NaNs in CCSM history files. Script examines all variables in ANN_ALL.nc file for NaNs. User specifies whether script allows NaNs and continues processing, or exits fatally if NaNs are found. If BLOCK_NAN is set to 0 (thereby allowing the diagnostic package to continue processing) all NaNs are set to missing in every set. The goal of this step is to avoid potential problems by bring NaNs to the users immediate attention, therefore the default/recommended settings enable both set_0 and BLOCK_NAN.
| Environment Variable | Default Setting | Description |
|---|---|---|
| set_0 | 0 | Pre-screen for NaNs in derived files. |
| BLOCK_NAN | 0 | Exit script if NaNs are found. |
Section 14: Analysis Sets
The diagnostics package performs a series of analyses that are divided into sets for convenience. Setting the set to 1 activates that analysis. Setting the set to 1 makes it inactive. See Appendix for detailed description.
| Environment Variable | Default Setting | Description |
|---|---|---|
| set_1 | 1 | Annual global trends. |
| Set_2 | 1 | Global contour plots. |
| Set_3 | 1 | Regional monthly plots of selected variables. |
| Set_4 | 0 | Vertical profiles (Atmospheric climatologies required) |
| Set_5 | 1 | Tables of annual means. |
| Set_6 | 1 | Annual regional and global trends of selected variables. |
| Set_7 | 1 | River flow and discharge (RTM required; QCHANR=QCHOCNR=0.05) |
| Set_8 | 0 | Ocean-atmosphere tracers (Atmospheric climatologies required) |
| Set_8_lnd | 0 | Land-atmosphere tracers |
| Set_9 | 1 | Validation statistics for model vs OBS (T, P, Albedo) |
Section 15: Restart
This option is useful for runs that fail after pre-processing, during the set analysis. For example: Sets 1, 2, and 3 completed, but set 4 fails for an arbitrary external reason (e.g., the machine goes down unexpectedly or you run out of space on your working directory). To restart the run at set 4 and avoid re-running sets 1-3, set the ‘restart_set_flag’ to 1, and set ‘restart_set’ to 4. Leave sets 1-3 turned on (1) so they are visible on the webpages where only active sets are listed.
| Environment Variable | Default Setting | Description |
|---|---|---|
| setRestart_flag | 0 | Turn on to restart analysis at ‘setRestart_set’. |
| setRestart_set | 2 | Valid options: 2,3,4,5,6,7,8,9 |
Section 16: User Preferences
Recommendation: New users should run a short test run (e.g., 5 yrs) with these flags turned off to be sure the diagnostics packages will run with their history files. Then turn the rmMonFiles* flags on to remove history files and save file space for longer runs. If you plan to extend this run by adding years or branching from the original diagnostics (e.g., extending an initial analysis of years 1-40 to years 1-100), be sure that deleteProcDir is turned off.
| Environment Variable | Default Setting | Description |
|---|---|---|
| rmMonFilesTrend | 1 | Remove monthly history files after trends are created |
| rmMonFilesClimo | 1 | Remove monthly history files after climo files are created |
| raster | 0 | Raster mode for set 2 plots |
| expContours | 1 | All contours are user defined for set2 plots. To set explicit contours when expContours=0, change 0 to 1 in $INPUT_HOME/set2_*.txt. |
| deleteProcDir | 1 | Delete processing directory |
Section 17a: Web Pages
| Environment Variable | Default setting | Description |
|---|---|---|
| web_pages | 1 | Create web page. |
Section 17b: Processing directives
| Environment Variable | Default Setting |
Description |
|---|---|---|
| delete_ps | 1 | Delete postscript files when analysis is complete. |
| delete_webdir | 1 | Delete web directory after tar file is created. |
| cleanup_Only | 0 | Cleanup directories after tar file is created (debug option) |
| webpage_Only | 0 | Skip to webpage creation (debug option) |
| ps2gif_Only | 0 | Skip to ps2gif conversion (debug option) |
| convert | 1 | Convert from ps to gif (debug option) |
Section 18: File Transfer
Send notification and scp tar file to local machine where you would like to view results in a browser.
| Environment Variable | Default Setting |
Description (1=ON; 0=OFF) |
|---|---|---|
| remote | 1 | Send email to user account |
| scpFile | 0 | Send tarfile to machine (requires interactive password) |
| Remote_system | ‘mymachine’ | Machine where you would like to post results. |
| Remote_dir | /web/web-date/tss/ | Local directory where you would like to store results. |
| Email_address | ‘myEmail@myaddress’ | Your email address. |
END: GENERAL USER MODIFIED SECTION
BEGIN: ADVANCED USER MODIFIED SECTION
Section 19: Significance testing
Path to land diagnostics package source code. Do not change this path unless you wish to create independent code changes. Note that revisions to the source code will not be broadcast to users who maintain a separate code base.
| Environment Variable | Default setting | Description |
|---|---|---|
| sig_lvl | 0.10 | Significance level for set 2 T-Test |
Section 20: Sub-Regions (INACTIVE)
| Environment Variable | Default setting | Description |
|---|---|---|
| reg_contour | 0 | Sub-regions active |
| min_lat | 30. | Southern boundary in degrees North |
| max_lat | 80. | Northern boundary in degrees North |
| min_lon | -130. | Western boundary in degrees East |
| max_lon | -50. | Eastern boundary in degrees East |
| OBS_RES | T42 | Observation resolution |
Section 21: Time Stamp (Inactive)
Turn on time stamp at bottom of plots.
| Environment Variable | Default setting | Description |
|---|---|---|
| time_stamp | 0 | INACTIVE |
Section 22: Image Format
| Environment Variable | Default setting | Description (PS is the only tested option) |
|---|---|---|
| p_type | ps | Postscript plots |
Section 23: Paleo-specific run directives.
| Environment Variable | Default Setting |
Description |
|---|---|---|
| paleo | 0 | 1=use or create coastlines |
| land_mask1 | 0 | Define value for land in test case |
| land_mask2 | 0 | Define value for land in standard case |
| paleo_diff_plots | 0 | Create difference plots for different continental outlines. |
END Users Guide
Appendix
A1. Directory Tree – CCSM History Files
The directory tree is created automatically by the land model diagnostics package (lnd_systems.csh). It includes the case directory, the model run directory (working directory), and subdirectories: model-obs or model1-model2.
| PTMPDIR | case_1_dir | caseid_1_annT_YEAR.nc caseid_1_clm2.h0.YEAR-MO.nc |
caseid_2_annT_YEAR.nc caseid_2_clm2.h0.YEAR-MO.nc |
| PTMPDIR | case_1_atm_dir | caseid_1_annT_atm_YEAR.nc caseid_1_cam2.h0.YEAR_MO.nc |
caseid_2_annT_atm_YEAR.nc caseid_2_cam2.h0.YEAR-MO.nc |
A2. Directory Tree – Trend Files
| PTMPDIR | prefix_1_dir prefix_2_dir |
prefix_1_ANN_ALL.nc prefix_1_ANN_means.nc |
prefix_2_ANN_ALL.nc prefix_2_ANN_means.nc |
| PTMPDIR | prefix_1_atm_dir prefix_2_atm_dir |
prefix_1_ANN_ALL_atm.nc prefix_1_ANN_means_atm.nc |
prefix_2_ANN_ALL_atm.nc prefix_2_ANN_means_atm.nc |
A3: Directory Tree – Climatology Files
| PTMPDIR | prefix_1_dir prefix_2_dir |
prefix_1_DJF_climo.nc prefix_1_MAM_climo.nc prefix_1_JJA_climo.nc prefix_1_SON_climo.nc prefix_1_MONS_climo.nc prefix_1_ANN_climo.nc |
prefix_2_DJF_climo.nc prefix_2_MAM_climo.nc prefix_2_JJA_climo.nc prefix_2_SON_climo.nc prefix_2_MONS_climo.nc prefix_2_ANN_climo.nc |
| PTMPDIR | prefix_1_dir prefix_2_dir |
prefix_1_DJF_means.nc prefix_1_MAM_means.nc prefix_1_JJA_means.nc prefix_1_SON_means.nc prefix_1_ANN_climo.nc prefix_1_ANN_means.nc |
prefix_2_DJF_means.nc prefix_2_MAM_means.nc prefix_2_JJA_means.nc prefix_2_SON_means.nc prefix_2_ANN_climo.nc prefix_2_ANN_means.nc |
| PTMPDIR | prefix_1_atm_dir prefix_2_atm_dir |
prefix_1_DJF_climo_atm.nc prefix_1_MAM_climo_atm.nc prefix_1_JJA_climo_atm.nc prefix_1_SON_climo_atm.nc prefix_1_MONS_climo_atm.nc prefix_1_ANN_climo_atm.nc |
prefix_2_DJF_climo_atm.nc prefix_2_MAM_climo_atm.nc prefix_2_JJA_climo_atm.nc prefix_2_SON_climo_atm.nc prefix_2_MONS_climo_atm.nc prefix_2_ANN_climo_atm.nc |
| PTMPDIR | Prefix_1_atm_dir Prefix_2_atm_dir |
prefix_1_DJF_means_atm.nc prefix_1_MAM_means_atm.nc prefix_1_JJA_means_atm.nc prefix_1_SON_means_atm.nc |
prefix_2_DJF_means_atm.nc prefix_2_MAM_means_atm.nc prefix_2_JJA_means_atm.nc prefix_2_SON_means_atm.nc |
A4: Directory Tree – Source Code
| DIAG_HOME | code/shared |
functions_contrib.ncl functions_tables.ncl lnd_NaNScreen.ncl lnd_createTarFile.csh lnd_create_webpage.pl lnd_driver.csh lnd_func.ncl lnd_getFiles.pm lnd_lookupTable.pl lnd_mons.pm lnd_NaNScreen.ncl lnd_preProcDriver.pl lnd_ps2gif.pl lnd_seas_climo.pm lnd_seas_means.pm lnd_statTable.pl lnd_systems.csh lnd_util.pm lnd_varMaster.pl lnd_write2mss.pl plot_functions.ncl raobs_station.ncl read_obs.ncl regional_values.ncl |
| DIAG_HOME | code/model-obs |
set_1.ncl set_2.ncl set_3.ncl set_4.ncl set_5.ncl set_6.ncl set_7.ncl set_8_DJF-JJA_contour.ncl set_8_ann_cycle.ncl set_8_ann_cycle_lnd.ncl set_8_contour.ncl set_8_trends.ncl set_8_zonal.ncl set_8_zonal_lnd.ncl |
| DIAG_HOME | code/model1-model2 |
set_1.ncl set_1DiffPlot.ncl set_2.ncl set_3.ncl set_4.ncl set_5.ncl set_6.ncl set_7.ncl set_8_DJF-JJA_contour.ncl set_8_ann_cycle.ncl set_8_ann_cycle_lnd.ncl set_8_contour.ncl set_8_trends.ncl set_8_zonal.ncl set_8_zonal_lnd.ncl set_9.ncl |
A6: Script Flags for Summary Files
| Environment Variable | Set | Description |
|---|---|---|
| trends_1 trends_2 |
Set 1 Set 6 |
Annual Trends |
| climo_1 climo_2 |
Set 2 Set 3 Set 5 Set 7 |
Monthly, annual and seasonal climatology and means |
| trends_atm_1 trends_atm_2 |
Set 8 | Annual Trends (Atmosphere) |
| climo_atm_1 climo_atm_2 |
Set 4 Set 8 |
Monthly, annual and seasonal climatology and means (Atmosphere) |
A7: Set Description and Required Summary Files
| Environment Variable | Description | Temporal | Spatial | Required Summary files |
|---|---|---|---|---|
| set_1 | Line plots | Annual Trends | Global | ANN_ALL |
| set_2 | Contour Plots | Long-term Climatology | Global |
DJF_climo MAM_climo JJA_climo SON_climo DJF_means MAM_ means JJA_ means SON_ means |
| set_3 | Line plots | Monthly Climatology | Regional | region_definitions MONS_climo |
| set_4 | Vertical profiles of atmosphere | Long-term climatology | Global |
RAOBS_new ANN_climo_atm MONS_climo_atm |
| set_5 | Summary table by category and variable | Long-term climatology | Global | region_definitions ANN_climo |
| set_6 | Line plots | Annual Trends | Regional | region_definitions ANN_ALL |
| set_7 | River flow and discharge Note: the RTM output (QCHANR and QCHOCNR) is at 0.5 degrees. | Long-term climatology | Regional and global | ANN_climo MONS_climo |
| set_8 + set_8_lnd | Line and contour plots | OCN-ATMOS tracers |
Global |
DJF_climo_atm MAM_climo_atm JJA_climo_atm SON_climo_atm MONS_climo_atm ANN_ALL_atm DJF_climo MAM_climo JJA_climo SON_climo |
| set_9 | Statistics table + contour plots | Monthly and seasonal climatology | Global |
MONS_climo DJF_climo DJF_means MAM_climo MAM_means JJA_climo JJA_means SON_climo SON_means |
A8: Summary File Creation
| Summary file | Contents | Time Dimension |
Dimensions | Created by |
|---|---|---|---|---|
| annT annT_atm |
Annual average from monthly history files. (ncra) | 1 |
Time Lat Lon |
Lnd_retrieve_data_case1 Lnd_retrieve_atm_case1 |
| ANN_ALL ANN_ALL_atm |
Annual records for all years specified by trends_num_yrs, starting with trends_first_yr. | nTrendYrs |
Time Lat Lon |
Lnd_netcdf_trends_case1 Lnd_netcdf_trends_atm_case1 |
| ANN_climo ANN_climo_atm |
Annual climatology | 1 |
Time Lat Lon |
Lnd_netcdf_climo_case1 Lnd_netcdf_climo_atm_case1 |
| MONS_climo MONS_climo_atm |
Monthly Climatology | 12 months |
Time Lat Lon |
Lnd_netcdf_climo_case1 Lnd_netcdf_climo_atm_case1 |
|
DJF_climo DJF_climo_atm MAM_climo MAM_climo _atm JJA_climo JJA_climo _atm SON_climo SON_climo _atm |
Seasonal Climatology | 1 |
Time Lat Lon |
Lnd_netcdf_climo_case1 Lnd_netcdf_climo_atm_case1 |
| ANN_means ANN_means _atm |
Annual means | nClimYrs |
Time Lat Lon |
Lnd_netcdf_climo_case1 Lnd_netcdf_climo_atm_case1 |
|
DJF_means DJF_means_atm MAM_ means MAM_means_atm JJA_means JJA_means_atm SON_means SON_means_atm |
Seasonal means | nClimYrs |
Time Lat Lon |
Lnd_netcdf_climo_case1 Lnd_netcdf_climo_atm_case1 |
| ANN_globalClimo | Global avg/total | nTrendYrs | time | Created by set_1.ncl from ANN_ALL.nc file |
A8. Directory Tree – Input Files
| DIAG_HOME | code/inputFiles |
set1_c13.txt* set1_clm.txt* set1_cn.txt* set2_c13.txt* set2_clm.txt* set2_cn.txt* set3_cnFlx.txt* set3_fireFlx.txt* set3_landFlx.txt* set3_moistEnergyFlx.txt* set3_radFlx.txt* set3_turbFlx.txt* set4_stationIds.txt* set5_c13.txt* set5_clm.txt* set5_cn.txt* set5_hydReg.txt* set6_cnFlx.txt* set6_fireFlx.txt* set6_landFlx.txt* set6_radFlx.txt* set6_turbFlx.txt* set8_ann_cycle.txt* set8_ann_cycle_lnd.txt* set8_contour.txt* set8_contour_DJF-JJA.txt* set8_trends.txt* set8_zonal.txt* set8_zonal_lnd.txt* variable_master4.2.ncl* |
A9: Input File Format (Required)
Each set has a separate list of input files. The set listing defines how the variables will be analyzed. For example, global temperature is globally averaged, while annual GPP is represented as a global total. In addition, sets may define the same variable differently depending on the set. For example, set 1 treats NEE as an annual global sum, and as a global daily average for set 2.
Set 2 uses an additional column in the input files to indicate whether the variable should be contoured using dynamic or pre-set contour intervals. Pre-set contour intervals are defined in variable_master4.2.ncl.
The addition of this feature allows the user to define the contour intervals for selected variables without requiring that all variables have either pre-set or dynamic contouring.
This feature is not available for set_8_contour.ncl, therefore all contour levels for this set are dynamic.
A10: Required Input File format: Sets 1, 3, 4, 5, 6, 7, 8, 9
Format:
| Column | 1-6 | 7-10 | 11-13 | 14-16 | 17 – |
|---|---|---|---|---|---|
| Options | global | Mean Totl |
Day Ann Nat |
[spaces] | Variable name from CCSM History file |
Example:
globalTotlAnn C13_NEE globalTotlAnn C13_NEP globalTotlAnn C13_GPP globalTotlAnn C13_PSNSUN_TO_CPOOL
A11: Required Input File format: Set 2
| Column | 1-6 | 7-10 | 11-13 | 14 | 15-16 | 17 – |
|---|---|---|---|---|---|---|
| Options | global | Mean Totl |
Day Ann Nat |
0 1 |
[spaces] | Variable name from CCSM History file |
Example: Set 2
globalMeanDay0 NEE globalMeanDay0 NEP globalMeanDay0 GPP globalMeanNat0 TSA
Options:
| Columns 11-13: | Units |
|---|---|
| Ann | Annual units |
| Day | Daily units |
| Nat | Native units from history file |
| Column 14: Dynamic Contour flag (set 2 ONLY) | ||
| 0 | Dynamic contours | |
| 1 | User defined contours | (NOTE: info@cn_Explicit must also be True) User-defined contour levels are set in variable_master.ncl. If you define user-defined contours you must copy the input files and variable_master to your personal workspace and reset INPUT_HOME |
| Columns 17 - … Variable Name |
Variable must either be defined on the history file or derived in lnd_func.ncl |
| Ann | Annual units |
| Day | Daily units |
| Nat | Native units from history file |