ufs-community / ufs-srweather-app

UFS Short-Range Weather Application
Other
55 stars 116 forks source link

Task name change from 'verb-like' to 'noun-like' to remove prefix 'run_' #633

Open chan-hoo opened 1 year ago

chan-hoo commented 1 year ago

Description

Solution

For the consistency, I propose to use noun-like naming rather than verb-like as follows:

Acceptance Criteria (Definition of Done)

gsketefian commented 1 year ago

@chan-hoo That mostly sounds good to me. A couple of things: 1) The tasks that get the external model files from which the ics and lbcs are generated are currently called get_extrn_ics and get_extrn_lbcs. Instead of changing these to extrn_ics and extrn_lbcs, can we change them to extrn_mdl_files_[ics|lbcs] to really distinguish them from the ics and lbcs tasks and to be consistent with the name of their ex-script (exregional_extrn_mdl_files.sh)? 2) Can you leave the changing of the vx task ex-scripts to me? In my next 1 or 2 PRs, I'm going to consolidate them into fewer scripts because several of these contain very similar code When I do that, I'll remove the run_ from the names.

Thanks.

chan-hoo commented 1 year ago

@gsketefian, thank you for your comments: 1) I'll update them 2) Sure. I am doing some urgent tasks now. I'll be able to make this change maybe next month unless someone else does this.

gsketefian commented 1 year ago

@chan-hoo Ok, sounds good. I may get to the changing of the vx task names before next month, we'll see.

BenjaminBlake-NOAA commented 1 year ago

After some internal discussion at EMC and with @christinaholtNOAA + others on the RRFS merge team, we think it makes sense to keep some verb prefixes attached to the RRFS tasks (and those currently in the SRW app) to keep them somewhat descriptive. However, we do feel that the run_* prefix should be removed, as it is superfluous and does not provide much added value. Here are some suggested names for the current SRW tasks and the RRFS tasks that will be added (excluding the verification tasks which @gsketefian plans to rename). Comments and feedback from anyone is welcomed and encouraged.

Current SRW app tasks get_extrn_ics --> get_extrn_mdl_files_ics (or leave these two as is) get_extrn_lbcs --> get_extrn_mdl_files_lbcs get_obs_ccpa (no change) get_obs_mrms (no change) get_obs_ndas (no change) make_grid (no change) make_ics (no change) make_lbcs (no change) make_orog (no change) make_sfc_climo (no change) plot_allvars (no change) plot_allvars_diff (no change) run_fcst ---> forecast run_post ---> post run_prdgen ---> gen_product (I believe @chan-hoo and @gsketefian suggested this in PR #631 )

RRFS tasks (not yet in SRW app) run_prepstart ---> prepstart (may want to think of a more descriptive name for what these prepstart tasks actually do) run_prepstart_ensmean ---> prepstart_ensmean run_prepstart_fromext ---> prepstart_fromext process_bufr ---> process_bufrobs (there are bufr tasks which refer to bufr postprocessing) process_lightning (no change) process_radarref (no change) run_ref2tten ---> prep_ref2tten (used in operational HRRR) or ref2tten run_anal ---> analysis or analysis_gsi run_enkf ---> enkf or analysis_enkf run_nonvarcldanl ---> analysis_nonvarcld run_postanal ---> update_lbc_soil (postanalysis is not good because post typically refers to running the UPP)

BenjaminBlake-NOAA commented 1 year ago

@JeffBeck-NOAA or @gsketefian - do either of you have any thoughts about the task names I've proposed here? I think it makes sense to keep most of the current task names the same, except for the forecast, post, and product generation jobs. Any feedback is much appreciated!

gsketefian commented 1 year ago

@BenjaminBlake-NOAA Your proposed renaming sounds good to me. For get_extrn_[ics|lbcs], my preference is to rename them to get_extrn_mdl_files_[ics|lbcs]. Thanks for asking!

JeffBeck-NOAA commented 1 year ago

@BenjaminBlake-NOAA, everything looks good here. I would also vote for the following:

run_anal ---> analysis_gsi run_enkf ---> analysis_enkf

BenjaminBlake-NOAA commented 1 year ago

@gsketefian @JeffBeck-NOAA Thank you both for your feedback! Your suggestions sound good to me. I'll open a PR soon for renaming the tasks currently in the SRW app.

BenjaminBlake-NOAA commented 1 year ago

@gsketefian In my PR I will not modify the names of the verification tasks, since you had said you would update those at some point to remove the run_ prefix.