Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add switch to control debug=true on WCOSS2 for development testing #2388

Merged
Merged
2 changes: 1 addition & 1 deletion .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ jobs:
if-no-files-found: ignore

- name: Comment ReadDocs Link in PR
if: github.event_name == 'pull_request'
if: ${{ github.event_name == 'pull_request' }}
uses: actions/github-script@v6
with:
script: |
Expand Down
112 changes: 57 additions & 55 deletions docs/source/configure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,58 +4,60 @@ Configure Run

The global-workflow configs contain switches that change how the system runs. Many defaults are set initially. Users wishing to run with different settings should adjust their $EXPDIR configs and then rerun the ``setup_xml.py`` script since some configuration settings/switches change the workflow/xml ("Adjusts XML" column value is "YES").

+----------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| Switch | What | Default | Adjusts XML | More Details |
+================+==================================+===============+=============+===================================================+
| APP | Model application | ATM | YES | See case block in config.base for options |
+----------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| DOIAU | Enable 4DIAU for control | YES | NO | Turned off for cold-start first half cycle |
| | with 3 increments | | | |
+----------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| DOHYBVAR | Run EnKF | YES | YES | Don't recommend turning off |
+----------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| DONST | Run NSST | YES | NO | If YES, turns on NSST in anal/fcst steps, and |
| | | | | turn off rtgsst |
+----------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| DO_AWIPS | Run jobs to produce AWIPS | NO | YES | downstream processing, ops only |
| | products | | | |
+----------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| DO_BUFRSND | Run job to produce BUFR | NO | YES | downstream processing |
| | sounding products | | | |
+----------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| DO_GEMPAK | Run job to produce GEMPAK | NO | YES | downstream processing, ops only |
| | products | | | |
+----------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| DO_FIT2OBS | Run FIT2OBS job | YES | YES | Whether to run the FIT2OBS job |
+----------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| DO_TRACKER | Run tracker job | YES | YES | Whether to run the tracker job |
+----------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| DO_GENESIS | Run genesis job | YES | YES | Whether to run the genesis job |
+----------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| DO_GENESIS_FSU | Run FSU genesis job | YES | YES | Whether to run the FSU genesis job |
+----------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| DO_VERFOZN | Run GSI monitor ozone job | YES | YES | Whether to run the GSI monitor ozone job |
+----------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| DO_VERFRAD | Run GSI monitor radiance job | YES | YES | Whether to run the GSI monitor radiance job |
+----------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| DO_VMINMON | Run GSI monitor minimization job | YES | YES | Whether to run the GSI monitor minimization job |
+----------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| DO_METP | Run METplus jobs | YES | YES | One cycle spinup |
+----------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| EXP_WARM_START | Is experiment starting warm | .false. | NO | Impacts IAU settings for initial cycle. Can also |
| | (.true.) or cold (.false)? | | | be set when running ``setup_expt.py`` script with |
| | | | | the ``--start`` flag (e.g. ``--start warm``) |
+----------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| HPSSARCH | Archive to HPPS | NO | Possibly | Whether to save output to tarballs on HPPS |
+----------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| LOCALARCH | Archive to a local directory | NO | Possibly | Instead of archiving data to HPSS, archive to a |
| | | | | local directory, specified by ATARDIR. If |
| | | | | LOCALARCH=YES, then HPSSARCH must =NO. Changing |
| | | | | HPSSARCH from YES to NO will adjust the XML. |
+----------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| QUILTING | Use I/O quilting | .true. | NO | If .true. choose OUTPUT_GRID as cubed_sphere_grid |
| | | | | in netcdf or gaussian_grid |
+----------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| WRITE_DOPOST | Run inline post | .true. | NO | If .true. produces master post output in forecast |
| | | | | job |
+----------------+----------------------------------+---------------+-------------+---------------------------------------------------+
+------------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| Switch | What | Default | Adjusts XML | More Details |
+==================+==================================+===============+=============+===================================================+
| APP | Model application | ATM | YES | See case block in config.base for options |
+------------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| DEBUG_POSTSCRIPT | Debug option for PBS scheduler | NO | YES | Sets debug=true for additional logging |
+------------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| DOIAU | Enable 4DIAU for control | YES | NO | Turned off for cold-start first half cycle |
| | with 3 increments | | | |
+------------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| DOHYBVAR | Run EnKF | YES | YES | Don't recommend turning off |
+------------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| DONST | Run NSST | YES | NO | If YES, turns on NSST in anal/fcst steps, and |
| | | | | turn off rtgsst |
+------------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| DO_AWIPS | Run jobs to produce AWIPS | NO | YES | downstream processing, ops only |
| | products | | | |
+------------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| DO_BUFRSND | Run job to produce BUFR | NO | YES | downstream processing |
| | sounding products | | | |
+------------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| DO_GEMPAK | Run job to produce GEMPAK | NO | YES | downstream processing, ops only |
| | products | | | |
+------------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| DO_FIT2OBS | Run FIT2OBS job | YES | YES | Whether to run the FIT2OBS job |
+------------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| DO_TRACKER | Run tracker job | YES | YES | Whether to run the tracker job |
+------------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| DO_GENESIS | Run genesis job | YES | YES | Whether to run the genesis job |
+------------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| DO_GENESIS_FSU | Run FSU genesis job | YES | YES | Whether to run the FSU genesis job |
+------------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| DO_VERFOZN | Run GSI monitor ozone job | YES | YES | Whether to run the GSI monitor ozone job |
+------------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| DO_VERFRAD | Run GSI monitor radiance job | YES | YES | Whether to run the GSI monitor radiance job |
+------------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| DO_VMINMON | Run GSI monitor minimization job | YES | YES | Whether to run the GSI monitor minimization job |
+------------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| DO_METP | Run METplus jobs | YES | YES | One cycle spinup |
+------------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| EXP_WARM_START | Is experiment starting warm | .false. | NO | Impacts IAU settings for initial cycle. Can also |
| | (.true.) or cold (.false)? | | | be set when running ``setup_expt.py`` script with |
| | | | | the ``--start`` flag (e.g. ``--start warm``) |
+------------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| HPSSARCH | Archive to HPPS | NO | Possibly | Whether to save output to tarballs on HPPS |
+------------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| LOCALARCH | Archive to a local directory | NO | Possibly | Instead of archiving data to HPSS, archive to a |
| | | | | local directory, specified by ATARDIR. If |
| | | | | LOCALARCH=YES, then HPSSARCH must =NO. Changing |
| | | | | HPSSARCH from YES to NO will adjust the XML. |
+------------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| QUILTING | Use I/O quilting | .true. | NO | If .true. choose OUTPUT_GRID as cubed_sphere_grid |
| | | | | in netcdf or gaussian_grid |
+------------------+----------------------------------+---------------+-------------+---------------------------------------------------+
| WRITE_DOPOST | Run inline post | .true. | NO | If .true. produces master post output in forecast |
| | | | | job |
+------------------+----------------------------------+---------------+-------------+---------------------------------------------------+
1 change: 1 addition & 0 deletions parm/config/gefs/config.base
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ export NMV="/bin/mv"
export NLN="/bin/ln -sf"
export VERBOSE="YES"
export KEEPDATA="NO"
export DEBUG_POSTSCRIPT="NO" # PBS only; sets debug=true
export CHGRP_RSTPROD="@CHGRP_RSTPROD@"
export CHGRP_CMD="@CHGRP_CMD@"
export NCDUMP="${NETCDF:-${netcdf_c_ROOT:-}}/bin/ncdump"
Expand Down
1 change: 1 addition & 0 deletions parm/config/gfs/config.base
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ export NMV="/bin/mv"
export NLN="/bin/ln -sf"
export VERBOSE="YES"
export KEEPDATA="NO"
export DEBUG_POSTSCRIPT="NO" # PBS only; sets debug=true
export CHGRP_RSTPROD="@CHGRP_RSTPROD@"
export CHGRP_CMD="@CHGRP_CMD@"
export NCDUMP="${NETCDF:-${netcdf_c_ROOT:-}}/bin/ncdump"
Expand Down
7 changes: 6 additions & 1 deletion workflow/rocoto/tasks.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ def __init__(self, app_config: AppConfig, cdump: str) -> None:
'cyc': '<cyclestr>@H</cyclestr>',
'COMROOT': self._base.get('COMROOT'),
'DATAROOT': self._base.get('DATAROOT')}

self.envars = self._set_envars(envar_dict)

@staticmethod
Expand Down Expand Up @@ -192,7 +193,11 @@ def get_resource(self, task_name):

native = None
if scheduler in ['pbspro']:
native = '-l debug=true,place=vscatter'
# Set place=vscatter by default and debug=true if DEBUG_POSTSCRIPT="YES"
if self._base['DEBUG_POSTSCRIPT']:
native = '-l debug=true,place=vscatter'
else:
native = '-l place=vscatter'
# Set either exclusive or shared - default on WCOSS2 is exclusive when not set
if task_config.get('is_exclusive', False):
native += ':exclhost'
Expand Down
Loading