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

Documentation: Provide more background information on the Taylor Diagram #435

Open
22 tasks
bikegeek opened this issue Apr 16, 2024 · 3 comments
Open
22 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: Community General Community type: task An actionable item of work

Comments

@bikegeek
Copy link
Collaborator

Replace italics below with details for this issue.

Describe the Task

The Taylor Diagram has minimal background information, requiring users to refer to the original paper by Taylor. To improve the user experience, provide additional information so users do not need to read Taylor's paper to use the plotting feature.

Time Estimate

Estimate the amount of work required here.
Issues should represent approximately 1 to 3 days of work.

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 CYCLE 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.
  • Add any new Python packages to the METplus Components Python Requirements table.
  • 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.
@bikegeek bikegeek added type: task An actionable item of work priority: medium Medium Priority component: documentation Documentation issue requestor: Community General Community alert: NEED ACCOUNT KEY Need to assign an account key to this issue labels Apr 16, 2024
@bikegeek bikegeek added this to the METplotpy-3.0.0 milestone Apr 16, 2024
@bikegeek bikegeek self-assigned this Apr 16, 2024
@jwraby
Copy link

jwraby commented Apr 16, 2024

Thanks for creating the issue and the opportunity to provide input to the future documentation, Minna. I think some clarification is needed to avoid misinterpretation, but the User's Guide does discuss the fact that the RMSE is bias-corrected and that the standard deviation is normalized, but most of my misinterpretation came from the data which was present in the METviewer R data tab (originally from the MET Point-Stat CNT output) that didn't agree with what I was seeing in the plot. Perhaps some linkage between the R data values and the values used to generate the diagram in an example might be useful along with the formulas you provided in the discussion would help.

@bikegeek
Copy link
Collaborator Author

bikegeek commented Apr 16, 2024 via email

@jwraby
Copy link

jwraby commented Apr 16, 2024

Yes. I would appreciate the opportunity to help on that!

@bikegeek bikegeek changed the title Provide more background information on the Taylor Diagram Documentation: Provide more background information on the Taylor Diagram May 15, 2024
@bikegeek bikegeek moved this from 🟢 Ready to 🎯 Up Next in METplus-Analysis-6.0.0 Development Oct 19, 2024
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: Community General Community type: task An actionable item of work
Projects
Status: No status
Development

No branches or pull requests

2 participants