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 the documentation for the HSS and HSS_EC statistics #2492

Closed
21 tasks
j-opatz opened this issue Mar 23, 2023 · 2 comments
Closed
21 tasks

Update the documentation for the HSS and HSS_EC statistics #2492

j-opatz opened this issue Mar 23, 2023 · 2 comments
Assignees
Labels
component: documentation Documentation issue priority: medium Medium Priority requestor: NOAA/CPC NOAA Climate Prediction Center type: task An actionable item of work
Milestone

Comments

@j-opatz
Copy link
Contributor

j-opatz commented Mar 23, 2023

Describe the Task

When the CPC project finished that formulated the HSS_EC creation, there was a suggested update to the documentation. That documentation was lost in the shuffle of finishing the project and getting use cases into the METplus repository, but is now being requested by CPC.

The documentation update is as follows:

Suggestion would be to (a) Remove the CPC HSS equation from the HSS documentation, and (b) Place the CPC HSS equation in the MET documentation for HSS_EC (below) with (c) explaining that for the option of prescribing C2, it would be that C2 = T * E, where E is the expected number of correct forecasts and E = T * expected % hits. For example CPC typically expects the % of hits for a tercile category to hit 33 percent of the time. The expected % hits is set by the GRID_STAT_HSS_EC_VALUE as a value between 0 and 1. The Ou, 2016 reference can be included with explaining the usage of E (bounded 0 to 1).

Time Estimate

1-2 hours

Sub-Issues

Consider breaking the task down into sub-issues.

  • Add a checkbox for each sub-issue here.

Relevant Deadlines

List relevant project deadlines here or state NONE.

Funding Source

Define the source of funding and account keys here or state NONE.

Define the Metadata

Assignee

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

Labels

  • Select component(s)
  • Select priority
  • Select requestor(s)

Projects and Milestone

  • Select Repository and/or Organization level Project(s) or add alert: NEED PROJECT ASSIGNMENT label
  • Select Milestone as the next official version or Future Versions

Define Related Issue(s)

Consider the impact to the other METplus components.

Task 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 issues
    Select: Repository level development cycle Project for the next official release
    Select: Milestone as the next official version
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Close this issue.
@j-opatz j-opatz added component: documentation Documentation issue type: task An actionable item of work priority: medium Medium Priority requestor: NOAA/CPC NOAA Climate Prediction Center labels Mar 23, 2023
@j-opatz j-opatz added this to the MET 11.1.0 milestone Mar 23, 2023
@j-opatz j-opatz self-assigned this Mar 23, 2023
@melissaOu
Copy link

CPC in house needs to work a little more on finalizing suggested documentation for HSS_EC. I will update comment here with a finalized version of suggested documentation edits when we are done.

@j-opatz
Copy link
Contributor Author

j-opatz commented May 25, 2023

The suggested updates to HSS and HSS_EC definitions were made to the develop branch and will appear in Appendix C

@j-opatz j-opatz closed this as completed May 25, 2023
@JohnHalleyGotway JohnHalleyGotway changed the title Update HSS and HSS_EC documentation Update the documentation of the HSS and HSS_EC statistics Jun 13, 2023
@JohnHalleyGotway JohnHalleyGotway changed the title Update the documentation of the HSS and HSS_EC statistics Update the documentation for the HSS and HSS_EC statistics Jun 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation Documentation issue priority: medium Medium Priority requestor: NOAA/CPC NOAA Climate Prediction Center type: task An actionable item of work
Projects
No open projects
Status: Done
Development

No branches or pull requests

2 participants