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: Enhancement to Difficulty Index use-case documentation #2123

Closed
9 of 21 tasks
hertneky opened this issue Apr 13, 2023 · 1 comment · Fixed by #2392
Closed
9 of 21 tasks

Documentation: Enhancement to Difficulty Index use-case documentation #2123

hertneky opened this issue Apr 13, 2023 · 1 comment · Fixed by #2392
Assignees
Labels
alert: NEED ACCOUNT KEY Need to assign an account key to this issue component: documentation Documentation issue priority: medium Medium Priority requestor: NOAA/WPC NOAA Weather Prediction Center type: enhancement Improve something that it is currently doing
Milestone

Comments

@hertneky
Copy link
Contributor

hertneky commented Apr 13, 2023

Describe the Enhancement

Documentation-only enhancement
Enhance the existing documentation for the Difficulty Index use-case.
Include description of the weighting function, which is defined by the user in the embedded python scripts.

Time Estimate

<1 day

Sub-Issues

None

Relevant Deadlines

none

Funding Source

NOAA WPC

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.

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.
  • 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.
@hertneky hertneky added type: enhancement Improve something that it is currently doing component: documentation Documentation issue priority: medium Medium Priority alert: NEED MORE DEFINITION Not yet actionable, additional definition required alert: NEED ACCOUNT KEY Need to assign an account key to this issue alert: NEED CYCLE ASSIGNMENT Need to assign to a release development cycle requestor: NOAA/WPC NOAA Weather Prediction Center labels Apr 13, 2023
@hertneky hertneky added this to the METplus-5.1.0 milestone Apr 13, 2023
@hertneky hertneky self-assigned this Apr 13, 2023
@hertneky hertneky removed alert: NEED MORE DEFINITION Not yet actionable, additional definition required alert: NEED CYCLE ASSIGNMENT Need to assign to a release development cycle labels Apr 13, 2023
@georgemccabe georgemccabe changed the title Enhancement to Difficulty Index use-case documentation Documentation: Enhancement to Difficulty Index use-case documentation May 10, 2023
@georgemccabe georgemccabe moved this from Todo to In Progress in METplus-Wrappers-5.1.0 Development Jul 24, 2023
@georgemccabe georgemccabe moved this from Todo to In Progress in METplus-Wrappers-6.0.0 Development Jul 26, 2023
@hertneky
Copy link
Contributor Author

The documentation of the Difficulty Index was moved to METcalcpy #332.

A small modification to the use-case in METplus will point to the external documentation about the algorithm and additional plotting capabilities.

@georgemccabe georgemccabe linked a pull request Oct 27, 2023 that will close this issue
14 tasks
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: NOAA/WPC NOAA Weather Prediction Center type: enhancement Improve something that it is currently doing
Projects
No open projects
Status: 🏁 Done
Development

Successfully merging a pull request may close this issue.

2 participants