From 0405140463f0935e87ab98e0666830b546eb728d Mon Sep 17 00:00:00 2001 From: mvertens Date: Wed, 1 Feb 2023 17:40:52 +0100 Subject: [PATCH] updated documentation for new docn changes and to document env_run.xml cdeps variables --- doc/source/datm.rst | 111 +++++++++++---- doc/source/dice.rst | 31 +++-- doc/source/dlnd.rst | 56 ++++++-- doc/source/docn.rst | 127 ++++++++++++++---- doc/source/drof.rst | 102 +++++++++----- doc/source/dwav.rst | 26 ++-- drof/cime_config/namelist_definition_drof.xml | 6 +- 7 files changed, 335 insertions(+), 124 deletions(-) diff --git a/doc/source/datm.rst b/doc/source/datm.rst index e606bb14..ff067209 100644 --- a/doc/source/datm.rst +++ b/doc/source/datm.rst @@ -5,13 +5,13 @@ Data Atmosphere (DATM) DATM is normally used to provide observational forcing data (or forcing data produced by a previous run using active components) to -drive prognostic components. The various ways of running DATM is +drive prognostic components. The various ways of running DATM is referred to as its mode. -In the case of CESM, the active model components would be: CTSM, -POP2, MOM6, POP2, CICE5-6, WW3 and MOSART. As examples, CORE2_NYF -(CORE2 normal year forcing) is the DATM mode used in driving -POP2 and MOM6. On the other hand CLM_QIAN, CLMCRUNCEP, CLMGSWP3 +In the case of CESM, the active model components would be: CTSM, +POP2, MOM6, POP2, CICE5-6, WW3 and MOSART. As examples, CORE2_NYF +(CORE2 normal year forcing) is the DATM mode used in driving +POP2 and MOM6. On the other hand CLM_QIAN, CLMCRUNCEP, CLMGSWP3 and CLM1PT are DATM modes using observational data for forcing CTSM. .. _datm-datamodes: @@ -36,7 +36,7 @@ CLMNCEP (``datm_datamode_clmncep_mod.F90``) infrastructure and data models to do active-land-only simulations. CORE2_NYF (``datm_datamode_core2_mod.F90``) - - Coordinated Ocean-ice Reference Experiments (CORE) Version 2 + - Coordinated Ocean-ice Reference Experiments (CORE) Version 2 Normalst_aquap[1-10]Year Forcing. CORE2_IAF (``datm_datamode_core2_mod.F90``) @@ -60,16 +60,16 @@ ERA5 (``datm_datamode_era5_mod.F90``) .. note:: Due to the high temporal and spatial resoultion of ERA5 dataset, only 2019 - data is staged on NCAR's Cheyenne platform under + data is staged on NCAR's Cheyenne platform under `$CESMDATAROOT/inputdata/atm/datm7/ERA5` .. note:: - In addition to the exiting DATM data modes, the `CDEPS fork `_ - used by `NOAA's UFS Weather Model `_ - also includes additional data modes such as CFSR, GEFS and GFS. These data modes are not + In addition to the exiting DATM data modes, the `CDEPS fork `_ + used by `NOAA's UFS Weather Model `_ + also includes additional data modes such as CFSR, GEFS and GFS. These data modes are not merged with the NCAR's authoritative repository yet but it is tested under UFS Weather model. - + .. _datm-cime-vars: --------------------------------------- @@ -77,25 +77,26 @@ Configuring DATM from CIME --------------------------------------- If CDEPS is coupled to the CIME-CCS then the CIME ``$CASEROOT`` xml -variable ``DATM_MODE`` sets the collection of streams that -are associated with DATM and also sets the datm namelist variable -``datamode`` in the file ``datm_in``. The following are the supported -DATM ``datamode`` values, as defined in the file -``namelist_definition_datm.xml``. +variable ``DATM_MODE`` will be generated based on the compset +specification ``DATM%{DATM_MODE}``. ``DATM_MODE`` will in term be +used in the ``namelist_definition_datm.xml`` file to determine the +collection of streams that are associated with DATM and also sets the +datm namelist variable ``datamode`` in the file ``datm_in``. -The following table describes the valid values of ``DATM_MODE`` +The following list describes the valid values of ``DATM_MODE`` (defined in the ``config_component.xml`` file for DATM), and how they relate to the associated input streams and the ``datamode`` namelist -variable. CIME will generate a value of ``DATM_MODE`` based on the -compset. +variable. -CORE2_NYF +DATM%CORE2_NYF, - CORE2 normal year forcing (CESM C ang G compsets) + - datm_mode: CORE2_NYF - streams: CORE2_NYF.GISS,CORE2_NYF.GXGXS,CORE2_NYF.NCEP - datamode: CORE2_NYF -CORE2_IAF +DATM%CORE2_IAF, - CORE2 interannual year forcing (CESM C ang G compsets) + - datm_mode: CORE2_IAF - streams: CORE2_IAF.GCGCS.PREC,CORE2_IAF.GISS.LWDN, CORE2_IAF.GISS.SWDN,CORE2_IAF.GISS.SWUP, CORE2_IAF.NCEP.DN10,CORE2_IAF.NCEP.Q_10, @@ -103,45 +104,97 @@ CORE2_IAF CORE2_IAF.NCEP.V_10,CORE2_IAF.CORE2.ArcFactor - datamode: CORE2_IAF -CORE_IAF_JRA +DATM%CORE_IAF_JRA - JRA-55 intra-annual year forcing (CESM C ang G compsets) - streams: CORE_IAF_JRA.PREC,CORE_IAF_JRA.LWDN,CORE_IAF_JRA.SWDN, CORE_IAF_JRA.Q_10,CORE_IAF_JRA.SLP\_,CORE_IAF_JRA.T_10,CORE_IAF_JRA.U_10, CORE_IAF_JRA.V_10,CORE_IAF_JRA.CORE2.ArcFactor - datamode: CORE_IAF_JRA -CLM_QIAN_WISO +DATM%CLM_QIAN_WISO - QIAN atm input data with water isotopes (CESM I compsets) + - datm_mode: CLMNCEP - streams: CLM_QIAN_WISO.Solar,CLM_QIAN_WISO.Precip,CLM_QIAN_WISO.TPQW - datamode: CLMNCEP -CLM_QIAN +DATM%CLM_QIAN - QIAN atm input data (CESM I compsets) + - datm_mode: CLMNCEP - streams: CLM_QIAN.Solar,CLM_QIAN.Precip,CLM_QIAN.TPQW - datamode: CLMNCEP -CLMCRUNCEPv7 +DATM%CLMCRUNCEPv7 - CRUNCEP atm input data (CESM I compsets) + - datm_mode: CLMNCEP - streams: CLMCRUNCEP.Solar,CLMCRUNCEP.Precip,CLMCRUNCEP.TPQW - datamode: CLMNCEP -CLMGSWP3 +DATM%CLMGSWP3 - GSWP3 atm input data (I compsets) + - datm_mode: CLMNCEP - streams: CLMGSWP3.Solar,CLMGSWP3.Precip,CLMGSWP3.TPQW - datamode: CLMNCEP -CLM1PT +DATM%CLM1PT - single point tower site atm input data + - datm_mode: CLMNCEP - streams: CLM1PT.$ATM_GRID - datamode: CLMNCEP -ERA5 +DATM%ERA5 - ERA5 atm input data (not used any compset) + - datm_mode: ERA5 - streams: ERA5_HOURLY - datamode: ERA5 -CPLHIST +DATM%CPLHIST - user generated forcing data from using coupler history files used to spinup relevant prognostic components (for CESM this is CLM, POP and CISM) + - datm_mode:CPLHIST - streams: CPLHISTForcing.Solar,CPLHISTForcing.nonSolarFlux, - datamode: CPLHIST + +In addition, the following DATM specific CIME-CCS xml variables will appear in ``$CASEROOT/env_run.xml``: + +DATM_PRESAERO + - DATM prescribed aerosol forcing mode + +DATM_TOPO + - DATM surface topography forcing (only needed for compsets with active land) + +DATM_CO2_TSERIES + - Full pathname for domain file for datm when DATM_MODE is + CPLHIST, NOTE: if this is set to 'null' (the default), then + domain information is read in from the first coupler history + file in the target stream and it is assumed that the first + coupler stream file that is pointed to contains the domain + information for that stream. + +DATM_CPLHIST_CASE + - Case name used to determine stream filenames when DATM_MODE is CPLHIST + +DATM_YR_START + - Starting year to loop data over + +DATM_YR_END + - Ending year to loop data over + +DATM_YR_ALIGN + - Simulation year corresponding to DATM_YR_START. A common usage + is to set this to RUN_STARTDATE. With this setting, the forcing + in the first year of the run will be the forcing of year + DATM_YR_START. Another use case is to align the calendar + of transient forcing with the model calendar. For example, + setting DATM_YR_ALIGN=DATM_YR_START will lead to + the forcing calendar being the same as the model calendar. The + forcing for a given model year would be the forcing of the same + year. This would be appropriate in transient runs where the + model calendar is setup to span the same year range as the + forcing data. + +DATM_SKIP_RESTART_READ + - If set to true, than datm restarts will not be read on a continuation run. + This capability is used, for example, in CTSM spinup runs. + + + diff --git a/doc/source/dice.rst b/doc/source/dice.rst index 2793edee..ebd5084b 100644 --- a/doc/source/dice.rst +++ b/doc/source/dice.rst @@ -4,7 +4,7 @@ Data Ice (DICE) =============== DICE is normally used to provide observational forcing data to -drive prognostic components. The various ways of running DICE is +drive prognostic components. The various ways of running DICE is referred to as its mode. .. _dice-datamodes: @@ -34,24 +34,27 @@ Configuring DICE from CIME --------------------------------------- If CDEPS is coupled to the CIME-CCS then the CIME ``$CASEROOT`` xml -variable ``DICE_MODE`` sets the collection of streams that -are associated with DICE and also sets the dice namelist variable -``datamode`` in the file ``dice_in``. The following are the supported -DICE ``datamode`` values, as defined in the file -``namelist_definition_dice.xml``. +variable ``DICE_MODE`` will be generated based on the compset +specification ``DICE%{DICE_MODE}``. ``DICE_MODE`` will in term be +used in the ``namelist_definition_dice.xml`` file to determine the +collection of streams that are associated with DICE and also sets the +dice namelist variable ``datamode`` in the file ``dice_in``. -The following table describes the valid values of ``DICE_MODE`` +The following list describes the valid values of ``DICE_MODE`` (defined in the ``config_component.xml`` file for DICE), and how they relate to the associated input streams and the ``datamode`` namelist -variable. CIME will generate a value of ``DICE_MODE`` based on the -compset. +variable. -ssmi +DICE%SSMI - Reads data from file + - dice_mode: ssmi - streams: ssmi_nyf - - datamode: ssmi + - datamode: ssmi -ssmi_iaf - - Reads data from file +DICE%IAF + - Reads data from file + - dice_mode: ssmi_iaf - streams: ssmi_iaf - - datamode: ssmi_iaf + - datamode: ssmi_iaf + +There are currently no DICE other specific xml variables in ``$CASEROOT/env_run.xml``. diff --git a/doc/source/dlnd.rst b/doc/source/dlnd.rst index 7a34983f..679cf58f 100644 --- a/doc/source/dlnd.rst +++ b/doc/source/dlnd.rst @@ -4,7 +4,7 @@ Data Land (DLND) ================ DLND is normally used to provide forcing data produced by a previous run -using active components to drive prognostic components. Currently, there +using active components to drive prognostic components. Currently, there is one way of running DLND is referred to as its mode. .. _dlnd-datamodes: @@ -21,7 +21,7 @@ with a DLND source file that carries out these operations and these are listed in parentheses next to the mode name. copyall (``lnd_comp_nuopc.F90``) - - This mode assumes that the data file has following variables: + - This mode assumes that the data file has following variables: 1. Surface temperature (`Sl_tsrf_elev`) in each elevation class 2. Surface topography (`Sl_topo_elev`) in each elevation class 3. SMB flux (`Flgl_qice_elev`) in each elevation class @@ -29,30 +29,58 @@ copyall (``lnd_comp_nuopc.F90``) .. _dlnd-cime-vars: --------------------------------------- -Configuring DLND from CIME +Configuring DLND using the CIME-CCS --------------------------------------- If CDEPS is coupled to the CIME-CCS then the CIME ``$CASEROOT`` xml -variable ``DLND_MODE`` sets the collection of streams that -are associated with DLND and also sets the dlnd namelist variable -``datamode`` in the file ``dlnd_in``. The following are the supported -DLND ``datamode`` values, as defined in the file -``namelist_definition_dlnd.xml``. +variable ``DLND_MODE`` will be generated based on the compset +specification ``DLND%{DLND_MODE}``. ``DLND_MODE`` will in term be +used in the ``namelist_definition_dlnd.xml`` file to determine the +collection of streams that are associated with DLND and also sets the +dlnd namelist variable ``datamode`` in the file ``dlnd_in``. -The following table describes the valid values of ``DLND_MODE`` +The following list describes the valid values of ``DLND_MODE`` (defined in the ``config_component.xml`` file for DLND), and how they relate to the associated input streams and the ``datamode`` namelist -variable. CIME will generate a value of ``DLND_MODE`` based on the -compset. +variable. -LCPL +DLND%LCPL - Non-snow coupling mode. Land forcing data (produced by CLM) from a previous - model run is read in from a coupler history file. + model run is read in from a coupler history file. + - dlnd_mode: SCPL - streams: lnd.cplhist - datamode: copyall -SCPL +DLND%SCPL - Snow coupling mode. Glacier coupling data (produced by CISM) from a previous model run is read in from a coupler history file. + - dlnd_mode: LCPL - streams: sno.cplhist - datamode: copyall + +In addition, the following DLND specific CIME-CCS xml variables will appear in ``$CASEROOT/env_run.xml``: + +DLND_CPLHIST_DIR + - directory for coupler history data mode + +DLND_CPLHIST_CASE + - case name for coupler history data mode + +DLND_CPLHIST_YR_START + - starting year to loop data over + +DLND_CPLHIST_YR_ALIGN + - Simulation year corresponding to DLND_CPLHIST_YR_START (only used + when DLND_MODE is CPLHIST or GLC_CPLHIST). A common usage is to + set this to RUN_STARTDATE. With this setting, the forcing in the + first year of the run will be the forcing of year + DLND_CPLHIST_YR_START. Another use case is to align the calendar + of transient forcing with the model calendar. For example, setting + DLND_CPLHIST_YR_ALIGN=DLND_CPLHIST_YR_START will lead to the + forcing calendar being the same as the model calendar. The forcing + for a given model year would be the forcing of the same year. This + would be appropriate in transient runs where the model calendar is + setup to span the same year range as the forcing data. + +DLND_SKIP_RESTART_READ + - If set to true, than dlnd restarts will not be read on a continuation run. diff --git a/doc/source/docn.rst b/doc/source/docn.rst index 80f7765c..d10852a6 100644 --- a/doc/source/docn.rst +++ b/doc/source/docn.rst @@ -5,7 +5,7 @@ Data Ocean (DOCN) DOCN is normally used to provide observational forcing data (or forcing data produced by a previous run using active components) to -drive prognostic components. The various ways of running DOCN is +drive prognostic components. The various ways of running DOCN is referred to as its mode. .. _docn-datamodes: @@ -22,8 +22,8 @@ with a DOCN source file that carries out these operations and these are listed in parentheses next to the mode name. sstdata and sst_aquap_file (``docn_datamode_copyall_mod.F90``) - - `sstdata` and `sst_aquap_file` modes assume that the only field in the - input stream is SST. It also assumes the SST is in Celsius and must be + - `sstdata` and `sst_aquap_file` modes assume that the only field in the + input stream is SST. It also assumes the SST is in Celsius and must be converted to Kelvin. All other fields are set to zero. .. note:: @@ -40,7 +40,7 @@ iaf (``docn_datamode_iaf_mod.F90``) sst_aquap_analytic, sst_aquap_constant and sst_aquap[1-10] (``docn_datamode_aquaplanet_mod.F90``) - This mode creates analytic sea surface temperature. In case of using `sst_aquap[1-10]` data mode, an additional information (`sst_option`) - is extracted from the data mode to change the behaviour of the + is extracted from the data mode to change the behaviour of the data mode such as the method of calculation of sea surface temperature. som and som_aquap (``docn_datamode_som_mod.F90``) @@ -56,61 +56,142 @@ som and som_aquap (``docn_datamode_som_mod.F90``) appropriate and is provided for testing and development purposes only. Users must create scientifically appropriate data for their particular application. A tool is available to derive valid SOM forcing. - + The only difference between `som` and `som_aquap` is that `som_aquap` limits sea surface temperature based on calculated value of freezing temperature. +cplhist (``docn_datamode_cplhist_mod.F90``) + .. _docn-cime-vars: --------------------------------------- -Configuring DOCN from CIME +Configuring DOCN using CIME-CCS --------------------------------------- If CDEPS is coupled to the CIME-CCS then the CIME ``$CASEROOT`` xml -variable ``DOCN_MODE`` sets the collection of streams that -are associated with DOCN and also sets the docn namelist variable -``datamode`` in the file ``docn_in``. The following are the supported -DOCN ``datamode`` values, as defined in the file -``namelist_definition_docn.xml``. +variable ``DOCN_MODE`` will be generated based on the compset +specification ``DOCN%{DOCN_MODE}``. ``DOCN_MODE`` will in term be +used in the ``namelist_definition_docn.xml`` file to determine the +collection of streams that are associated with DOCN and also sets the +docn namelist variable ``datamode`` in the file ``docn_in``. -The following table describes the valid values of ``DOCN_MODE`` +The following list describes the valid values of ``DOCN_MODE`` (defined in the ``config_component.xml`` file for DOCN), and how they relate to the associated input streams and the ``datamode`` namelist -variable. CIME will generate a value of ``DOCN_MODE`` based on the -compset. +variable. -prescribed +DOCN%DOM - SST data provided by a file - - streams: prescribed + - docn_mode: prescribed + - streams: prescribed - datamode: sstdata -interannual +DOCN%IAF - SST data provided by a file + - docn_mode: interannual - streams: interannual - datamode: iaf -som +DOCN%SOM - Slab Ocean Model is used to calculate sea surface temperature. + - docn_mode: som - streams: som - datamode: som -som_aquap +DOCN%SOMAQP - Slab Ocean Model is used to calculate sea surface temperature. - - streams: som_aquap + - docn_mode: som_aquap + - streams: N/A - datamode: som_aquap -sst_aquap[1-10] +DOCN%AQP[1-10] - Lattitude varying analytical sea surface data + - docn_mode: sst_aquap[1-10] - streams: N/A - datamode: sst_aquap[1-10] -sst_aquap_file +DOCN%AQPFILE - SST data provided by a file + - docn_mode: sst_aquap_file - streams: aquapfile - datamode: sst_aquapfile -sst_aquap_constant +DOCN%AQPCONST - Constant sea surface data from aquaplanet + - docn_mode: sst_aquap_constant - streams: N/A - datamode: sst_aquap_constant + + +In addition, the following list outlines the DOCN specific CIME-CCS xml variables that appear in ``$CASEROOT/env_run.xml``: + +SSTICE_DATA_FILENAME + - Prescribed SST and ice coverage data file name. + Sets SST and ice coverage data file name. + This is only used when DOCN%DOM or DOCN%IAF is present in the compset. + (used by both DOCN and CICE running in prescribed mode) + +SSTICE_MESH_FILENAME + - Prescribed SST and ice coverage mesh file name. + Sets SST and ice coverage grid file name for prescribed runs. + This is only used when DOCN%DOM or DOCN%IAF is present in the compset. + (used by both DOCN and CICE running in prescribed mode) + +SSTICE_YR_START + - Starting year to loop data over + (only used by both DOCN runing in prescribed mode and CICE running in prescribed mode) + +SSTICE_YR_END + - Ending year to loop data over + (only used by both DOCN runing in prescribed mode and CICE running in prescribed mode) + +SSTICE_YR_ALIGN + - The model year that corresponds to SSTICE_YEAR_START on the data file. + Prescribed SST and ice coverage data will be aligned so that the first year of + data corresponds to SSTICE_YEAR_ALIGN in the model. For instance, if the first + year of prescribed data is the same as the first year of the model run, this + should be set to the year given in RUN_STARTDATE. + If SSTICE_YEAR_ALIGN is later than the model's starting year, or if the model is + run after the prescribed data ends (as determined by SSTICE_YEAR_END), the + default behavior is to assume that the data from SSTICE_YEAR_START to + SSTICE_YEAR_END cyclically repeats. This behavior is controlled by the + "taxmode" stream option; see the data model documentation for more details. + (only used by both DOCN runing in prescribed mode and CICE running in prescribed mode) + +DOCN_AQPCONST_VALUE + - Sets globally constant SST value and is only used when DOCN%AQPCONST is present in the compset. + +DOCN_SOMAQP_DATAFILE + - Sets the SOM aquaplanet file and is only used when DOCN%AQPFILE is present in the compset. + +DOCN_CPLHIST_YR_START + - Starting year to loop data over + Only used if DOCN_MODE=cplhist. + +DOCN_CPLHIST_YR_END + - Ending year to loop data over + Only used if DOCN_MODE=cplhist. + +DOCN_CPLHIST_YR_ALIGN + - Simulation year corresponding to DOCN_CPLHIST_YR_START. A common usage + is to set this to RUN_STARTDATE. With this setting, the forcing + in the first year of the run will be the forcing of year + DOCN_CPLHIST_YR_START. Another use case is to align the calendar + of transient forcing with the model calendar. For example, + setting DOCN_CPLHIST_YR_ALIGN=DOCN_CPLHIST_YR_START will lead to + the forcing calendar being the same as the model calendar. The + forcing for a given model year would be the forcing of the same + year. This would be appropriate in transient runs where the + model calendar is setup to span the same year range as the forcing data. + Only used if DOCN_MODE=cplhist. + +DOCN_IMPORT_FIELDS + - A column delimited set of import fields that are advertised by DOCN but never used. + In some cases it is needed for DOCN to advertise import fields even though it never will actually use them. + This is needed in order for the mediator to add fields that would + be sent to the ocean from the atmosphere, ice and runoff if the + ocean were prognostic. + If the value of DOCN_IMPORT_FIELDS is 'none' then no import fields are advertised + by DOCN. If the DOCN_IMPORT_FIELDS is set to 'Faxa_bcph:Faxa_dstdry:Faxa_dstwet:So_duu10n:Si_ifrac' then + these fields will be written to the mediator history file(s). diff --git a/doc/source/drof.rst b/doc/source/drof.rst index 9457d445..abcda2f4 100644 --- a/doc/source/drof.rst +++ b/doc/source/drof.rst @@ -32,84 +32,124 @@ Configuring DROF from CIME --------------------------------------- If CDEPS is coupled to the CIME-CCS then the CIME ``$CASEROOT`` xml -variable ``DROF_MODE`` sets the collection of streams that -are associated with DROF and also sets the DROF namelist variable -``datamode`` in the file ``drof_in``. The following are the supported -DROF ``datamode`` values, as defined in the file -``namelist_definition_drof.xml``. +variable ``DROF_MODE`` will be generated based on the compset +specification ``DROF%{DROF_MODE}``. ``DROF_MODE`` will in term be +used in the ``namelist_definition_drof.xml`` file to determine the +collection of streams that are associated with DROF and also sets the +drof namelist variable ``datamode`` in the file ``drof_in``. -The following table describes the valid values of ``DROF_MODE`` +The following list describes the valid values of ``DROF_MODE`` (defined in the ``config_component.xml`` file for DROF), and how they relate to the associated input streams and the ``datamode`` namelist -variable. CIME will generate a value of ``DROF_MODE`` based on the -compset. +variable. -CPLHIST +DROF%CPLHIST - Reads data from coupler history file + - drof_mode: CPLHIST - streams: rof.cplhist - datamode: copyall -DIATREN_ANN_RX1 +DROF%DIATREN_ANN_RX1 - Annual Average data from Dai_Trenberth Continental Freshwater Discharge + - drof_mode: DIATREN_ANN_RX1 - streams: rof.diatren_ann_rx1 - datamode: copyall -DIATREN_ANN_AIS00_RX1 +DROF%DIATREN_ANN_AIS00_RX1 - Annual Average data from Dai_Trenberth Continental Freshwater Discharge + - drof_mode: DIATREN_ANN_AIS00_RX1 - streams: rof.diatren_ann_ais00_rx1 - datamode: copyall -DIATREN_ANN_AIS45_RX1 +DROF%DIATREN_ANN_AIS45_RX1 - Annual Average data from Dai_Trenberth Continental Freshwater Discharge + - drof_mode: DIATREN_ANN_AIS45_RX1 - streams: rof.diatren_ann_ais45_rx1 - datamode: copyall -DIATREN_ANN_AIS55_RX1 +DROF%DIATREN_ANN_AIS55_RX1 - Annual Average data from Dai_Trenberth Continental Freshwater Discharge + - drof_mode: DIATREN_ANN_AIS55_RX1 - streams: rof.diatren_ann_ais55_rx1 - datamode: copyall -DIATREN_IAF_AIS00_RX1 +DROF%DIATREN_IAF_RX1 - Monthly data from Dai_Trenberth Continental Freshwater Discharge - - streams: rof.diatren_iaf_ais00_rx1 + - drof_mode: DIATREN_IAF_RX1 + - streams: rof.diatren_iaf_rx1 - datamode: copyall -DIATREN_IAF_RX1 +DROF%DIATREN_IAF_AIS00_RX1 - Monthly data from Dai_Trenberth Continental Freshwater Discharge - - streams: rof.diatren_iaf_rx1 + - drof_mode: DIATREN_IAF_AIS00_RX1 + - streams: rof.diatren_iaf_ais00_rx1 - datamode: copyall -DIATREN_IAF_AIS45_RX1 +DROF%DIATREN_IAF_AIS45_RX1 - Monthly data from Dai_Trenberth Continental Freshwater Discharge + - drof_mode: DIATREN_IAF_AIS45_RX1 - streams: rof.diatren_iaf_ais45_rx1 - datamode: copyall -DIATREN_IAF_AIS55_RX1 +DROF%DIATREN_IAF_AIS55_RX1 - Monthly data from Dai_Trenberth Continental Freshwater Discharge + - drof_mode: DIATREN_IAF_AIS55_RX1 - streams: rof.diatren_iaf_ais55_rx1 - datamode: copyall -IAF_JRA_1p4_2018 - - JRA-55 based river runoff data (2018) - - streams: rof.iaf_jra_1p4_2018 - - datamode: copyall - -IAF_JRA +DROF%IAF_JRA - JRA-55 based river runoff data + - drof_mode: IAF_JRA - streams: rof.iaf_jra - datamode: copyall -RYF8485_JRA - - JRA55 v1.3 1984 May - 1985 Apr RAF +DROF%IAF_JRA_1p4_2018 + - JRA-55 based river runoff data (2018) + - drof_mode: IAF_JRA_1p4_2018 + - streams: rof.iaf_jra_1p4_2018 + - datamode: copyall + +DROF%RYF8485_JRA + - JRA55 v1.3 data from 1984 May - 1985 Apr RAF + - drof_mode: RYF8485_JRA - streams: rof.ryf8485_jra - datamode: copyall -RYF9091_JRA - - JRA55 v1.3 1990 May - 1991 Apr RAF +DROF%RYF9091_JRA + - JRA55 v1.3 data from 1990 May - 1991 Apr RAF + - drof_mode: RYF9091_JRA - streams: rof.ryf9091_jra - datamode: copyall -RYF0304_JRA - - JRA55 v1.3 2003 May - 2004 Apr RAF +DROF%RYF0304_JRA + - JRA55 v1.3 data form 2003 May - 2004 Apr RAF + - drof_mode: RYF0304_JRA - streams: rof.ryf0304_jra - datamode: copyall + +In addition, the following DATM specific CIME-CCS xml variables will appear in ``$CASEROOT/env_run.xml``: + +DROF_CPLHIST_CASE + - Case name used to determine stream filenames when DROF_MODE is CPLHIST + +DROF_CPLHIST_YR_START + - starting year to loop data over (only used when DROF_MODE is CPLHIST) + +DROF_CPLHIST_YR_END + - ending year to loop data over (only used when DROF_MODE is CPLHIST) + +DROF_CPLHIST_YR_ALIGN + - Simulation year corresponding to DROF_CPLHIST_YR_START (only used + when DROF_MODE is CPLHIST). A common usage is to set this to + RUN_STARTDATE. With this setting, the forcing in the first year of + the run will be the forcing of year DROF_CPLHIST_YR_START. Another + use case is to align the calendar of transient forcing with the + model calendar. For example, setting + DROF_CPLHIST_YR_ALIGN=DROF_CPLHIST_YR_START will lead to the + forcing calendar being the same as the model calendar. The forcing + for a given model year would be the forcing of the same year. This + would be appropriate in transient runs where the model calendar is + setup to span the same year range as the forcing data. + +DROF_SKIP_RESTART_READ + - If set to true, than drof restarts will not be read on a continuation run diff --git a/doc/source/dwav.rst b/doc/source/dwav.rst index 551c4443..94bb9f30 100644 --- a/doc/source/dwav.rst +++ b/doc/source/dwav.rst @@ -39,23 +39,29 @@ copyall (``wav_comp_nuopc.F90``) .. _dwav-cime-vars: --------------------------------------- -Configuring DWAV from CIME +Configuring DWAV using the CIME-CCS --------------------------------------- If CDEPS is coupled to the CIME-CCS then the CIME ``$CASEROOT`` xml -variable ``DWAV_MODE`` sets the collection of streams that -are associated with DWAV and also sets the DWAV namelist variable -``datamode`` in the file ``dwav_in``. The following are the supported -DROF ``datamode`` values, as defined in the file -``namelist_definition_dwav.xml``. +variable ``DWAV_MODE`` will be generated based on the compset +specification ``DWAV%{DWAV_MODE}``. ``DWAV_MODE`` will in term be +used in the ``namelist_definition_dwav.xml`` file to determine the +collection of streams that are associated with DWAV and also sets the +dwav namelist variable ``datamode`` in the file ``dwav_in``. -The following table describes the valid values of ``DWAV_MODE`` +The following list describes the valid values of ``DWAV_MODE`` (defined in the ``config_component.xml`` file for DWAV), and how they relate to the associated input streams and the ``datamode`` namelist -variable. CIME will generate a value of ``DWAV_MODE`` based on the -compset. +variable. -CLIMO +DWAV%CLIMO - Reads data from wave climatology file + - dwav_mode: CLIMO - streams: climo - datamode: copyall + +In addition, the following DICE specific CIME-CCS xml variables will appear in ``$CASEROOT/env_run.xml``: + +DWAV_SKIP_RESTART_READ + - If set to true, than dice restarts will not be read on a continuation run. + diff --git a/drof/cime_config/namelist_definition_drof.xml b/drof/cime_config/namelist_definition_drof.xml index 846139e1..88a3493b 100644 --- a/drof/cime_config/namelist_definition_drof.xml +++ b/drof/cime_config/namelist_definition_drof.xml @@ -10,17 +10,17 @@ streams_file List of streams used for the given drof_mode. - rof.cplhist + rof.cplhist rof.diatren_ann_rx1 rof.diatren_ann_ais00_rx1 rof.diatren_ann_ais45_rx1 rof.diatren_ann_ais55_rx1 - rof.diatren_iaf_ais00_rx1 rof.diatren_iaf_rx1 + rof.diatren_iaf_ais00_rx1 rof.diatren_iaf_ais45_rx1 rof.diatren_iaf_ais55_rx1 - rof.iaf_jra_1p4_2018 rof.iaf_jra + rof.iaf_jra_1p4_2018 rof.ryf8485_jra rof.ryf9091_jra rof.ryf0304_jra