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

Improve documentation on Python Embedding for point observations #2303

Closed
21 tasks
DanielAdriaansen opened this issue Oct 14, 2022 · 1 comment · Fixed by #2509
Closed
21 tasks

Improve documentation on Python Embedding for point observations #2303

DanielAdriaansen opened this issue Oct 14, 2022 · 1 comment · Fixed by #2509
Assignees
Labels
MET: Python Embedding priority: high High Priority requestor: Navy/NRL Naval Research Laboratory type: enhancement Improve something that it is currently doing
Milestone

Comments

@DanielAdriaansen
Copy link
Contributor

Describe the Enhancement

Improve the documentation for Python Embedding with point data:

  1. Include more explicit information on the expected data types required, or add clarification to existing documentation
  2. Include a new section on the helper script for transforming point_data to met_point_data once Add a Python helper script/function to transform point_data objects to met_point_data objects for Python Embedding #2302 is complete.

Time Estimate

4 hours

Sub-Issues

Consider breaking the enhancement 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.

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) and Linked 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.
@DanielAdriaansen DanielAdriaansen added type: enhancement Improve something that it is currently doing requestor: Navy/NRL Naval Research Laboratory 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 MET: Python Embedding priority: high High Priority labels Oct 14, 2022
@DanielAdriaansen DanielAdriaansen added this to the MET 11.0.0 milestone Oct 14, 2022
@DanielAdriaansen DanielAdriaansen self-assigned this Oct 14, 2022
@JohnHalleyGotway JohnHalleyGotway moved this to 📋 Backlog in MET-11.1.0 Development Dec 9, 2022
@JohnHalleyGotway JohnHalleyGotway moved this from 📋 Backlog to 🔖 Ready in MET-11.1.0 Development Dec 9, 2022
@DanielAdriaansen DanielAdriaansen linked a pull request Apr 14, 2023 that will close this issue
15 tasks
@DanielAdriaansen
Copy link
Contributor Author

Completed in #2509.

@github-project-automation github-project-automation bot moved this from 🔖 Ready to ✅ Done in MET-11.1.0 Development Apr 21, 2023
@JohnHalleyGotway JohnHalleyGotway removed 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 labels Oct 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
MET: Python Embedding priority: high High Priority requestor: Navy/NRL Naval Research Laboratory 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