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.

Sign up for GitHub

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

Jump to bottom

Clean up METplus use case configuration files #1402

Closed
21 tasks
georgemccabe opened this issue Feb 2, 2022 · 2 comments · Fixed by #1690 or #1722
Closed
21 tasks

Clean up METplus use case configuration files #1402

georgemccabe opened this issue Feb 2, 2022 · 2 comments · Fixed by #1690 or #1722
Assignees
@georgemccabe
Labels
METplus: Configuration priority: high High Priority reporting: DTC NOAA BASE NOAA Office of Atmospheric Research DTC Project requestor: METplus Team METplus Development Team requestor: NCAR National Center for Atmospheric Research 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
METplus-5.0.0

Comments

@georgemccabe
Copy link
Collaborator

georgemccabe commented Feb 2, 2022 •
edited
Loading

Replace italics below with details for this issue.

Describe the Enhancement

Provide a description of the enhancement request here.

Time Estimate

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

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

2792541

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.
@georgemccabe georgemccabe added type: enhancement Improve something that it is currently doing priority: high High Priority requestor: NCAR National Center for Atmospheric Research 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: METplus Team METplus Development Team METplus: Configuration labels Feb 2, 2022
@georgemccabe georgemccabe added this to the METplus-4.1.0 milestone Feb 2, 2022
@georgemccabe georgemccabe self-assigned this Feb 2, 2022
georgemccabe added a commit that referenced this issue Feb 2, 2022
@georgemccabe
Per #1402, added additional comments to config file including links t…
4a0afcf 
…o documentation. Added old format version of config file that contain many comments with the _DIR/_TEMPLATE variables grouped together for comparison
@georgemccabe
Copy link
Collaborator Author

I created 2 versions of the GridStat.conf basic use case to show potential ways to organize the variables.

Group variables by category, few comments with links to documentation: https://github.com/dtcenter/METplus/blob/7046183ea763365e1e485ae063618f49efb00c58/parm/use_cases/met_tool_wrapper/GridStat/GridStat.conf

Group variables by category with original comments left in place: https://github.com/dtcenter/METplus/blob/7046183ea763365e1e485ae063618f49efb00c58/parm/use_cases/met_tool_wrapper/GridStat/GridStat_comments.conf

The latter provides more information in the files themselves, but makes it very difficult to maintain as information can change. Any of these files that are copied and modified by users will contain out-of-date information.

@georgemccabe
Copy link
Collaborator Author

This would be a good time determine which variables are required to be set for a wrapper and which are optional. We should sort them accordingly in the config files are add comments to note which are optional and which are required. The information in the documentation Python Wrappers chapter should also be updated to reflect the accurate info.

@georgemccabe georgemccabe added required: FOR DEVELOPMENT RELEASE Required to be completed in the development release for the assigned project and removed alert: NEED CYCLE ASSIGNMENT Need to assign to a release development cycle labels Apr 26, 2022
georgemccabe added a commit that referenced this issue Jun 30, 2022
@georgemccabe
per #1402, rearrange and clean up config file
6ae90f2
georgemccabe added a commit that referenced this issue Jul 6, 2022
@georgemccabe
per #1402, clean up use case conf files, ci-run-all-diff
6c45365
georgemccabe added a commit that referenced this issue Jul 6, 2022
@georgemccabe
per #1402, clean up Point2Grid conf file
2d76352
georgemccabe added a commit that referenced this issue Jul 6, 2022
@georgemccabe
per #1402, clean up rest of met_tool_wrapper use case conf files, ci-…
551f8c7 
…run-all-diff
@georgemccabe georgemccabe linked a pull request Jul 6, 2022 that will close this issue
feature #1402 config cleanup - met_tool_wrapper #1690
Merged
14 tasks
georgemccabe added a commit that referenced this issue Jul 14, 2022
@georgemccabe
feature #1402 config cleanup - met_tool_wrapper (#1690)
e6825c4 
* Per #1402, added additional comments to config file including links to documentation. Added old format version of config file that contain many comments with the _DIR/_TEMPLATE variables grouped together for comparison

* rearrange variables and added link to user's guide

* updated comment to note that variables in the section are optional

* added URL for use case documentation

* per #1402, rearrange and clean up config file

* added missing config variables from CyclonePlotter to glossary and wrappers doc pages

* per #1402, clean up use case conf files, ci-run-all-diff

* per #1402, clean up Point2Grid conf file

* per #1402, clean up rest of met_tool_wrapper use case conf files, ci-run-all-diff

* removed conf file that is no longer needed
georgemccabe added a commit that referenced this issue Jul 14, 2022
@georgemccabe
per #1402, clean up use cases in air_quality_and_comp, climate, and d…
049fb1c 
…ata_assimilation
georgemccabe added a commit that referenced this issue Jul 14, 2022
@georgemccabe
per #1402, clean up use cases in marine_and_cryosphere
c0787cb
georgemccabe added a commit that referenced this issue Jul 15, 2022
@georgemccabe
per #1402, clean up use case config files for medium_range use cases
22a2737
georgemccabe added a commit that referenced this issue Jul 19, 2022
@georgemccabe
per #1402, rearrange and clean up config files for precipitation use …
664ec51 
…cases
georgemccabe added a commit that referenced this issue Jul 22, 2022
@georgemccabe
per #1402, rearrange and clean up config files for s2s, s2s_mid_lat, …
ce09848 
…and s2s_mjo. ci-run-all-diff
@georgemccabe georgemccabe removed the alert: NEED MORE DEFINITION Not yet actionable, additional definition required label Jul 22, 2022
georgemccabe added a commit that referenced this issue Jul 22, 2022
@georgemccabe
per #1402, rearrange and clean up config files for short_range use cases
4e2c002
georgemccabe added a commit that referenced this issue Jul 22, 2022
@georgemccabe
per #1402, rearrange and clean up space_weather config files
da4e01b
georgemccabe added a commit that referenced this issue Jul 22, 2022
@georgemccabe
per #1402, updated another use case conf
c5b2a9a
georgemccabe added a commit that referenced this issue Jul 22, 2022
@georgemccabe
per #1402, rearrange and clean up config files for tc_and_extra_tc us…
40ee888 
…e cases. ci-run-all-diff
@georgemccabe georgemccabe linked a pull request Jul 27, 2022 that will close this issue
Feature #1402 config cleanup model applications #1722
Merged
14 tasks
@georgemccabe georgemccabe added reporting: DTC NOAA BASE NOAA Office of Atmospheric Research DTC Project and removed alert: NEED ACCOUNT KEY Need to assign an account key to this issue labels Jul 27, 2022
hankenstein2 added a commit that referenced this issue Aug 3, 2022
@hankenstein2
Merge pull request #1722 from dtcenter/feature_1402_config_cleanup_mo…
a585524 
…del_app

Feature #1402 config cleanup model applications
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@georgemccabe georgemccabe

Labels
METplus: Configuration priority: high High Priority reporting: DTC NOAA BASE NOAA Office of Atmospheric Research DTC Project requestor: METplus Team METplus Development Team requestor: NCAR National Center for Atmospheric Research 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
No open projects
METplus-Wrappers-5.0.0-beta2 (8/3/22)
Status: Done
Milestone
METplus-5.0.0
1 participant
@georgemccabe