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

Improvements to TCMPRPlotter wrapper logging and output control #926

Closed
20 of 21 tasks
georgemccabe opened this issue May 12, 2021 · 2 comments · Fixed by #959
Closed
20 of 21 tasks

Improvements to TCMPRPlotter wrapper logging and output control #926

georgemccabe opened this issue May 12, 2021 · 2 comments · Fixed by #959
Assignees
Labels
component: use case wrapper priority: blocker Blocker reporting: DTC NOAA R2O NOAA Research to Operations DTC Project requestor: NOAA/EMC NOAA Environmental Modeling Center required: FOR DEVELOPMENT RELEASE Required to be completed in the development release for the assigned project type: enhancement Improve something that it is currently doing
Milestone

Comments

@georgemccabe
Copy link
Collaborator

georgemccabe commented May 12, 2021

There are a few improvements that could be made to TCMPRPlotter:

  • Currently TCMPRPlotter does not call the functionality to run commands that the rest of the wrappers do, so it does not output any of the log information from the Rscript run
  • The environment variable(s) set by the wrapper and the command called are not output in the logs in the same way as the other wrappers. This may be remedied with the changes for the first item.
  • The error handling logic references a produtil item that has not been imported, so the wrapper crashes on error

We should consider if time is better spent updating this wrapper or implement the R logic in Python inside METplotpy and replace this wrapper with a call to METplotpy.

Describe the Enhancement

Enhance the TCMPRPlotter wrapper to implement the improvements listed above.

Time Estimate

~3 days

Sub-Issues

Consider breaking the enhancement down into sub-issues.

  • Add a checkbox for each sub-issue here.

Relevant Deadlines

4.1.0

Funding Source

2788881

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)

If we decide to migrate this logic to METplotpy/METcalcpy instead of fixing the wrapper, we will need to create issues in the appropriate repositories:

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: use case wrapper priority: blocker Blocker requestor: NOAA/EMC NOAA Environmental Modeling Center alert: NEED MORE DEFINITION Not yet actionable, additional definition required alert: NEED ACCOUNT KEY Need to assign an account key to this issue labels May 12, 2021
@georgemccabe georgemccabe added this to the METplus-4.1.0 milestone May 12, 2021
@TaraJensen TaraJensen added the required: FOR DEVELOPMENT RELEASE Required to be completed in the development release for the assigned project label May 17, 2021
@georgemccabe
Copy link
Collaborator Author

From MET Help 99800, we should add quotation marks around the value set in TC_PAIRS_FILTER if they are not added already. Without this, tc_stat filter arguments cannot contain more than 1 string.

@georgemccabe georgemccabe self-assigned this Jun 1, 2021
@georgemccabe
Copy link
Collaborator Author

Improvements to the wrapper have been made in branch feature_926_tcmprplotter_logging. This version was made available on Hera and Jet for 2 users to test and ensure that the changes allow them to create the plots they desire. Once I receive feedback I will make adjustments as needed and create a pull request to close this issue.

@TaraJensen TaraJensen removed the alert: NEED ACCOUNT KEY Need to assign an account key to this issue label Jun 7, 2021
@georgemccabe georgemccabe linked a pull request Jun 17, 2021 that will close this issue
12 tasks
@TaraJensen TaraJensen added reporting: DTC NOAA R2O NOAA Research to Operations DTC Project and removed alert: NEED MORE DEFINITION Not yet actionable, additional definition required labels Jun 29, 2021
@georgemccabe georgemccabe changed the title Update TCMPRPlotter wrapper to improve logging output Improvements to TCMPRPlotter wrapper logging and output control Jul 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: use case wrapper priority: blocker Blocker reporting: DTC NOAA R2O NOAA Research to Operations DTC Project requestor: NOAA/EMC NOAA Environmental Modeling Center required: FOR DEVELOPMENT RELEASE Required to be completed in the development release for the assigned project type: enhancement Improve something that it is currently doing
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants