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

Update rst documentation for toggling on/off workflow tasks #646

Closed
gsketefian opened this issue Dec 6, 2021 · 1 comment
Closed

Update rst documentation for toggling on/off workflow tasks #646

gsketefian opened this issue Dec 6, 2021 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@gsketefian
Copy link
Collaborator

Description

Update rst documentation for variables introduced in PR #645 for toggling on/off tasks. Documentation already exists in config_defaults.sh.

Solution

Update the necessary rst file.

Related to (optional)

PR #645.

@gsketefian gsketefian added the enhancement New feature or request label Dec 6, 2021
@gsketefian gsketefian added documentation Improvements or additions to documentation and removed enhancement New feature or request labels Dec 6, 2021
gsketefian added a commit that referenced this issue Dec 6, 2021
## DESCRIPTION OF CHANGES:
1. Add capability to turn on/off those workflow tasks that currently do not have this capability.  These tasks are:
  a. Getting the external model files for creating initial conditions (`GET_EXTRN_ICS_TN`).
  b. Getting the external model files for creating boundary conditions (`GET_EXTRN_LBCS_TN`).
  c. Regridding/interpolating data from the external model IC files to obtain IC fields on the native grid (`MAKE_ICS_TN`).
  d. Regridding/interpolating data from the external model LBC files to obtain LBC fields on the native grid (`MAKE_LBCS_TN`).
  e. Running the forecast (`RUN_FCST`).
Note that any remaining tasks in the workflow already have the capability to be toggled on/off.

2. Add a WE2E test (named `deactivate_tasks`) to test the ability to turn off tasks.  In this test, all the tasks except `MAKE_GRID_TN`, `MAKE_OROG_TN`, and `MAKE_SFC_CLIMO_TN` are turned off (the latter 3 are not turned off because there is already a separate WE2E for turning those three off).

## TESTS CONDUCTED: 
Ran the new WE2E test (`deactivate_tasks`) successfully on Hera.

## DOCUMENTATION:
Necessary documentation has been included in `config_defaults.sh`.  Created Issue #646 to also update rst documentation.
@jwolff-ncar jwolff-ncar added this to the v2 release milestone Feb 3, 2022
@jwolff-ncar
Copy link
Contributor

Closing and moving to ufs-srweather-app.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants