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

List external dependencies in use case documentation files #767

Closed
6 of 21 tasks
georgemccabe opened this issue Jan 21, 2021 · 3 comments · Fixed by #866
Closed
6 of 21 tasks

List external dependencies in use case documentation files #767

georgemccabe opened this issue Jan 21, 2021 · 3 comments · Fixed by #866
Assignees
Labels
alert: NEED ACCOUNT KEY Need to assign an account key to this issue alert: NEED MORE DEFINITION Not yet actionable, additional definition required component: documentation Documentation issue priority: high High Priority requestor: METplus Team METplus Development Team type: enhancement Improve something that it is currently doing
Milestone

Comments

@georgemccabe
Copy link
Collaborator

There are currently only 3 use case docs that have an "External Dependencies" section.

  • docs/use_cases/model_applications/precipitation/GridStat_fcstHREFmean_obsStgIV_Gempak.py
  • docs/use_cases/met_tool_wrapper/GempakToCF/GempakToCF.py
  • docs/use_cases/met_tool_wrapper/PCPCombine/PCPCombine_python_embedding.py

There are many more use cases that require additional Python packages that are used in the Python embedding scripts.

Describe the Enhancement

Add information about external requirements to use case docs that have them. We should also make sure that any Python embedding scripts used in a use case are added to the use case doc file with a "literalinclude."

Time Estimate

~2 days

Sub-Issues

Consider breaking the enhancement down into sub-issues.

  • Add a checkbox for each sub-issue here.

Relevant Deadlines

Ideally 4.0.0

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

  • Review projects and select relevant Repository and Organization ones or add "alert:NEED PROJECT ASSIGNMENT" label
  • Select milestone to next major version milestone 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.
  • 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), Project(s), Milestone, and Linked issues
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Close this issue.
@georgemccabe georgemccabe added type: enhancement Improve something that it is currently doing component: documentation Documentation issue priority: high High Priority alert: NEED MORE DEFINITION Not yet actionable, additional definition required alert: NEED ACCOUNT KEY Need to assign an account key to this issue requestor: METplus Team METplus Development Team labels Jan 21, 2021
@georgemccabe georgemccabe added this to the METplus-4.0 milestone Jan 21, 2021
@j-opatz j-opatz self-assigned this Apr 2, 2021
@j-opatz j-opatz linked a pull request Apr 5, 2021 that will close this issue
11 tasks
@georgemccabe
Copy link
Collaborator Author

@jopatz can this issue be closed? I see there was a pull request for this work.

@jopatz
Copy link

jopatz commented Apr 29, 2021

@georgemccabe I don't know, but maybe @j-opatz does :)

@georgemccabe
Copy link
Collaborator Author

Sorry for the accidental tag!

@j-opatz j-opatz closed this as completed May 3, 2021
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 alert: NEED MORE DEFINITION Not yet actionable, additional definition required component: documentation Documentation issue priority: high High Priority requestor: METplus Team METplus Development Team type: enhancement Improve something that it is currently doing
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants