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

Enhance the OBTYPE header column for MPR and ORANK line types #2893

Closed
7 of 22 tasks
JohnHalleyGotway opened this issue May 17, 2024 · 1 comment · Fixed by #2995
Closed
7 of 22 tasks

Enhance the OBTYPE header column for MPR and ORANK line types #2893

JohnHalleyGotway opened this issue May 17, 2024 · 1 comment · Fixed by #2995
Assignees
Labels
MET: Grid-to-Point Verification priority: high High Priority requestor: UK Met Office United Kingdom Met Office type: enhancement Improve something that it is currently doing
Milestone

Comments

@JohnHalleyGotway
Copy link
Collaborator

JohnHalleyGotway commented May 17, 2024

Describe the Enhancement

This issue arose via dtcenter/METplus#2476 discussion from @robdarvell.

The OBTYPE stat header column is populated based on the message type specified in the Point-Stat and Ensemble-Stat configuration files. The same OBTYPE string is written for all STAT output line types generated by each verification task, including the matched pair (MPR) and observation rank (ORANK) line types.

However, the message_type_group_map configuration option enables multiple input message types to be grouped together into the same verification task. In Rob's example he's grouping both AUTO and MANU message types together into a group named SURF. Rather than setting OBTYPE to SURF in output MPR lines, he'd prefer to write the input obtype name instead.

This task is to enhance the Point-Stat and Ensemble-Stat tools where the message_type_group_map is involved in the setting of the OBTYPE output column. Provide the option of writing OBTYPE for the MPR and ORANK lines using the original input message type rather than the mapped name of the group.

Recommend adding this logic through a configurable option rather than making a wholesale change:
obtype_as_group_val_flag = FALSE
Where FALSE (default) maintains the current behavior of writing SURF, and TRUE would write the original observation message types of AUTO of MANU instead.

This would support the MetOffice usage without changing the output for others.

Time Estimate

2 days?

Sub-Issues

Consider breaking the enhancement down into sub-issues.
None needed.

Relevant Deadlines

List relevant project deadlines here or state NONE.

Funding Source

2799991

Define the Metadata

Assignee

  • Select engineer(s) or no engineer required
  • Select scientist(s) or no scientist required

Labels

  • Review default alert labels
  • Select component(s)
  • Select priority
  • Select requestor(s)

Milestone and Projects

  • Select Milestone as the next official version or Backlog of Development Ideas
  • For the next official version, select the MET-X.Y.Z Development project

Define Related Issue(s)

Consider the impact to the other METplus components.

Enhancement Checklist

See the METplus Workflow for details.

  • Complete the issue definition above, including the Time Estimate and Funding Source.
  • Fork this repository or create a branch of develop.
    Branch name: feature_<Issue Number>_<Description>
  • Complete the development and test your changes.
  • Add/update log messages for easier debugging.
  • Add/update unit tests.
  • Add/update documentation.
  • Push local changes to GitHub.
  • Submit a pull request to merge into develop.
    Pull request: feature <Issue Number> <Description>
  • Define the pull request metadata, as permissions allow.
    Select: Reviewer(s) and Development issue
    Select: Milestone as the next official version
    Select: MET-X.Y.Z Development project for development toward the next official release
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Close this issue.
@JohnHalleyGotway JohnHalleyGotway added type: enhancement Improve something that it is currently doing requestor: UK Met Office United Kingdom Met Office alert: NEED ACCOUNT KEY Need to assign an account key to this issue MET: Grid-to-Point Verification priority: high High Priority labels May 17, 2024
@JohnHalleyGotway JohnHalleyGotway added this to the MET 12.0.0 milestone May 17, 2024
@JohnHalleyGotway JohnHalleyGotway self-assigned this May 17, 2024
@robdarvell
Copy link

Just an additional bit of context regarding this change. It could be asked as to why couldn't you have 2 GROUP_MAP keys, one just containing AUTO and one just MANU and then run your job from that.
That was one option which was looked at. There was one issue with that approach. It was noted that as we use a time window for which observations to use, there were occasional times where within the window, there were 2 obs for a location, one which came from AUTO and the other from MANU. We only want one of these to be stored (the one nearest), and with the 2 group approach you would get the nearest for MANU and also the nearest for AUTO (which is not the desired outcome).

@JohnHalleyGotway JohnHalleyGotway moved this from 🟢 Ready to 🏗 In progress in MET-12.0.0 Development Oct 15, 2024
JohnHalleyGotway added a commit that referenced this issue Oct 15, 2024
…and Ensemble-Stat that applies when writing MPR, SEEPS_MPR, and ORANK line types. If true, write the input observation message type to the OBTYPE output column rather than the name of the group.
JohnHalleyGotway added a commit that referenced this issue Oct 15, 2024
JohnHalleyGotway added a commit that referenced this issue Oct 15, 2024
…at already include the message_type_group_map entry.
JohnHalleyGotway added a commit that referenced this issue Oct 15, 2024
…it write MPR output with obtype_as_group_val_flag = TRUE. Note that I switched the message types from ADPSFC, SFCSHP, USERSF to just USERSF. The original reason for the 3 was to prove that the counts for ADPSFC + SFCSHP = USERSF.
@JohnHalleyGotway JohnHalleyGotway linked a pull request Oct 15, 2024 that will close this issue
17 tasks
JohnHalleyGotway added a commit that referenced this issue Oct 16, 2024
JohnHalleyGotway added a commit that referenced this issue Oct 16, 2024
@JohnHalleyGotway JohnHalleyGotway moved this from 🏗 In progress to 🔎 In review in MET-12.0.0 Development Oct 16, 2024
JohnHalleyGotway added a commit that referenced this issue Oct 16, 2024
* Per #2893, add obtype_as_obs_message_type_flag option for Point-Stat and Ensemble-Stat that applies when writing MPR, SEEPS_MPR, and ORANK line types. If true, write the input observation message type to the OBTYPE output column rather than the name of the group.

* Per #2893, add option to default config files and fix compilation errors.

* Per #2893, change the name from obtype_as_obs_message_type_flag to obtype_as_group_val_flag.

* Per #2893, add docs ci-run-unit

* Per #2893, add obtype_as_group_val_flag entry for all config files that already include the message_type_group_map entry.

* Per #2893, modify existing PointStatConfig_WINDS config file to have it write MPR output with obtype_as_group_val_flag = TRUE. Note that I switched the message types from ADPSFC, SFCSHP, USERSF to just USERSF. The original reason for the 3 was to prove that the counts for ADPSFC + SFCSHP = USERSF.

* Per #2893, update commit history for ensemble_stat and point_stat

* Per #2893, revert back PointStatConfig_WINDS to minimize diffs

* Per #2893, add a Point-Stat unit test to demonstrate setting the obtype_as_group_val_flag option.

* Per #2893, need to reset the obtype after writing all MPR, SEEPS_MPR, and ORANK line types in Point-Stat

* Per #2893, tweak Point-Stat configuration to also write HIRA ORANK and PCT outputs.
@github-project-automation github-project-automation bot moved this from 🔎 In review to 🏁 Done in MET-12.0.0 Development Oct 16, 2024
@JohnHalleyGotway JohnHalleyGotway removed the alert: NEED ACCOUNT KEY Need to assign an account key to this issue label Oct 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
MET: Grid-to-Point Verification priority: high High Priority requestor: UK Met Office United Kingdom Met Office type: enhancement Improve something that it is currently doing
Projects
Status: 🏁 Done
Development

Successfully merging a pull request may close this issue.

2 participants