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

Document the scorecard <threshold_file> in the METviewer User's Guide #564

Open
8 of 21 tasks
JohnHalleyGotway opened this issue Jan 30, 2025 · 0 comments
Open
8 of 21 tasks
Assignees
Labels
alert: NEED ACCOUNT KEY Need to assign an account key to this issue component: documentation Documentation issue priority: medium Medium Priority requestor: DTC/T&E General DTC Testing and Evaluation work type: task An actionable item of work

Comments

@JohnHalleyGotway
Copy link
Contributor

Describe the Task

While working on scorecards for HAFS, @briannen needed to use the <threshold_file> scorecard option to modify colors, symbols, thresholds, and so on. While that XML tag is mentioned in the METviewer User's Guide, no description or example of its contents are provided.

This issue is to add a new section to the Scorecard chapter of the METviewer User's Guide about the <threshold_file> options. Please see examples from @CPKalb from 2020 (the last time this question came up) showing CAM scorecards in:
dakota:/d3/projects/USWRP_CAM/metv/thresh_test_sigdiff.xml

Recommend that @briannen do this work and request @bikegeek to review the updated content.

Time Estimate

Approx 4 hours

Sub-Issues

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

Relevant Deadlines

List relevant project deadlines here or state NONE.

Funding Source

Please coordinate with @KathrynNewman and @michelleharrold on funding through HAFS or other DTC keys.

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 a METviewer-X.Y.Z version, Consider for Next Release, or Backlog of Development Ideas
  • For a METviewer-X.Y.Z version, select the METviewer-X.Y.Z Development project

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 issue
    Select: Milestone as the next official version
    Select: METviewer-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 alert: NEED ACCOUNT KEY Need to assign an account key to this issue component: documentation Documentation issue priority: medium Medium Priority requestor: DTC/T&E General DTC Testing and Evaluation work type: task An actionable item of work labels Jan 30, 2025
@JohnHalleyGotway JohnHalleyGotway added this to the METviewer-6.1.0 milestone Jan 30, 2025
@github-project-automation github-project-automation bot moved this to 🩺 Needs Triage in METplus-6.1.0 Development Jan 30, 2025
@JohnHalleyGotway JohnHalleyGotway moved this from 🩺 Needs Triage to 🟢 Ready in METplus-6.1.0 Development Jan 30, 2025
@JohnHalleyGotway JohnHalleyGotway changed the title Documentation: Add the description and example of the scorecard <threshold_file> to the METviewer User's Guide Document the scorecard <threshold_file> in the METviewer User's Guide Jan 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
alert: NEED ACCOUNT KEY Need to assign an account key to this issue component: documentation Documentation issue priority: medium Medium Priority requestor: DTC/T&E General DTC Testing and Evaluation work type: task An actionable item of work
Projects
Status: 🟢 Ready
Development

No branches or pull requests

2 participants