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

Add a section to the METplus User's Guide about what questions to ask when applying METplus to a new testing and evaluation project. #650

Closed
10 of 21 tasks
JohnHalleyGotway opened this issue Oct 12, 2020 · 1 comment · Fixed by #1573
Assignees
Labels
component: documentation Documentation issue priority: medium Medium Priority reporting: DTC AF METplus Air Force METplus Project reporting: DTC NOAA BASE NOAA Office of Atmospheric Research DTC Project requestor: UK Met Office United Kingdom Met Office required: FOR OFFICIAL RELEASE Required to be completed in the official release for the assigned milestone type: enhancement Improve something that it is currently doing
Milestone

Comments

@JohnHalleyGotway
Copy link
Collaborator

JohnHalleyGotway commented Oct 12, 2020

Describe the Enhancement

This idea arose during the METplus telecon with the UK MetOffice on 10/12/2020.
Over the years, we have applied MET, and now the METplus wrappers, to many testing and evaluation projects. And for each new application, we tend to ask a similar set of questions. A sample set of those questions is listed below. For users new to METplus or new to verification in general, the questions that should be considered may not be obvious.

This task to survey the current set of METplus developers and users and document the relevant questions. Specifically, these are the questions to be asked when setting applying METplus to a new testing and evaluation project, which may consist of one or more use cases. Organize the feedback into a new section (full chapter or sub-section of existing chapter?) of the METplus User's Guide with clear, consistent, and practical advice to users. Care should be taken to ensure the questions are scientifically relevant but specific enough to be actionable in a METplus configuration file.

Recommend that after each question, we provide some practical suggestions based on possible answers to that question. So, how will the answer to this question impact the user's METplus configuration file or files?

Sample questions include (PLEASE ADD TO THIS LIST):

  • What are the questions you are trying to answer with this testing and evaluation project?
  • How should the testing and evaluation project be broken down into METplus Use Cases? One large one or multiple smaller ones?
  • How will METplus be run? Manually? Scheduled, through cron? Automated via a workflow manger (e.g. Rocoto, EC-Flow, Rose-Cylc)?
  • Where will METplus be run? Local machine, project machine, HPC system, in the cloud (e.g. AWS)? Serial runs or parallelized?
  • What is the evaluation time period? Retrospective with specific dates? Ongoing, near-realtime evaluation? Or both retrospective and realtime?
  • What is the geographic location of the model data being evaluated?
  • What observation or analysis datasets are available during this time period and which correspond to the model location? Is the verifying data point-based, gridded, or both?
  • Do you want to evaluate on the model domain, observation domain (if gridded), or some other domain?
  • ADD NEW QUESTIONS HERE.
  • Can you please create a graphical flow chart for quick reference and for visual learners?

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

2771021

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.
@JohnHalleyGotway JohnHalleyGotway added type: enhancement Improve something that it is currently doing component: documentation Documentation issue priority: medium Medium Priority requestor: UKMO alert: NEED CYCLE ASSIGNMENT Need to assign to a release development cycle labels Oct 12, 2020
@JohnHalleyGotway JohnHalleyGotway added this to the METplus-4.0 milestone Oct 12, 2020
@JohnHalleyGotway JohnHalleyGotway added requestor: UK Met Office United Kingdom Met Office and removed requestor: UKMO labels Dec 11, 2020
@TaraJensen TaraJensen added the required: FOR OFFICIAL RELEASE Required to be completed in the official release for the assigned milestone label May 17, 2021
@georgemccabe georgemccabe removed the alert: NEED CYCLE ASSIGNMENT Need to assign to a release development cycle label Jan 18, 2022
lisagoodrich added a commit that referenced this issue Mar 17, 2022
lisagoodrich added a commit that referenced this issue Mar 17, 2022
lisagoodrich added a commit that referenced this issue Mar 17, 2022
lisagoodrich added a commit that referenced this issue Mar 17, 2022
lisagoodrich added a commit that referenced this issue Mar 17, 2022
lisagoodrich added a commit that referenced this issue Mar 17, 2022
lisagoodrich added a commit that referenced this issue Mar 17, 2022
lisagoodrich added a commit that referenced this issue Mar 18, 2022
Cleaning up "you" and changing to 3rd person.  Except where "you" is referenced by a program example  #650
lisagoodrich added a commit that referenced this issue Mar 18, 2022
Taking another stab at making the bullets consistent #650
lisagoodrich added a commit that referenced this issue Apr 5, 2022
lisagoodrich added a commit that referenced this issue Apr 5, 2022
lisagoodrich added a commit that referenced this issue Apr 5, 2022
lisagoodrich added a commit that referenced this issue Apr 18, 2022
@jprestop jprestop linked a pull request Apr 19, 2022 that will close this issue
13 tasks
lisagoodrich added a commit that referenced this issue Apr 21, 2022
lisagoodrich added a commit that referenced this issue Apr 21, 2022
lisagoodrich added a commit that referenced this issue Apr 21, 2022
lisagoodrich added a commit that referenced this issue Jul 25, 2022
* adding new questions section

* changing table config #650

* odd section bullets #650

* adding in the rest of the text but not formatted #650

* first attempt at bullet formatting #650

* fixing errors #650

* fixing errors take 2 #650

* fixing errors take 3 #650

* fixing errors take 4 #650

* fixing errors take 5 #650

* Update systemconfiguration.rst

Cleaning up "you" and changing to 3rd person.  Except where "you" is referenced by a program example  #650

* Update systemconfiguration.rst

Taking another stab at making the bullets consistent #650

* creating new getting_started file to house Questions to Consider that was removed from the systemconfiguration file.

* moving Running METplus into getting_started file and removing it from the systemconfiguration. #650

* updating index to include new Getting Started chapter #650.

* updating index to include new Getting Started chapter take 2 #650.

* shortening the chapter name to Installation and Configuration #650

* using updated questions #650

* Made a few formatting/wording changes

* Removed text

* adding flowchart question and adding periods #650

* bolding files #650

* adding changes John O. recommended. #650

* small John O. change #650

* removing duplicate question #650

* fixing question order #650

* fixing typos Tara requested

* answering question 2.1.1.7

* adding Use Case Rules link to 2.1.1.7

* adding proper link to the Add Use Cases in the Contributors Guide

* trying to get link to work

* trying to get link to work take 2

* trying to get link to work take 3

* trying to get link to work take 4

* removing unnecessary link

* fixing punctuation

Co-authored-by: Julie Prestopnik <[email protected]>
georgemccabe pushed a commit that referenced this issue Apr 6, 2023
Co-authored-by: Julie Prestopnik <[email protected]>
Co-authored-by: johnhg <[email protected]>
Co-authored-by: cristianastan2 <[email protected]>
Co-authored-by: John Halley Gotway <[email protected]>
Co-authored-by: bikegeek <[email protected]>
Co-authored-by: Lisa Goodrich <[email protected]>
Co-authored-by: Julie Prestopnik <[email protected]>
Co-authored-by: George McCabe <[email protected]>
Co-authored-by: Hank Fisher <[email protected]>
Co-authored-by: Dan Adriaansen <[email protected]>
Co-authored-by: jprestop <[email protected]>
Co-authored-by: Tracy Hertneky <[email protected]>
Co-authored-by: j-opatz <[email protected]>
Co-authored-by: lisagoodrich <[email protected]>
Co-authored-by: bikegeek <[email protected]>
Co-authored-by: j-opatz <[email protected]>
Co-authored-by: Will Mayfield <[email protected]>
Co-authored-by: metplus-bot <[email protected]>
Co-authored-by: Tracy Hertneky <[email protected]>
fixing some spacing #770
Fixing formatting, typos etc.  #770
Fixing formatting  #770
fixing typos, spacing, etc. #770
fixing typos, grammar and punctuation. #770
Fixing TOC and coding block #770
fixing note #770
fix.  Updating bolding and italics for file names and directories #770
fixing space #770
fixing conflict #2 #770
fixing typos #770
fixing typos #2 #770
fixing formatting #770
fixing errors #650
fixing errors take 2 #650
fixing errors take 3 #650
fixing errors take 4 #650
fixing errors take 5 #650
fixing question order #650
fix #1706 fix PhaseDiagram use case to avoid writing into INPUT_BASE (#1708)
fix #1713 develop METPLOTPY_BASE (#1715)
fix #1691 remove whitespace from output file paths (#1721)
fix Contributor's Guide GitHub Workflow page (#1774)
fix release (#1790)
fix GitHub Actions warnings (#1864)
fix #1884 develop PCPCombine {custom} in subtract method (#1887)
fix #1939 develop - failure reading obs when zipped file also exists (#1941)
Closes #1986
fix develop Fix broken documentation links (#2004)
fix #2026 develop StatAnalysis looping (#2028)
fix priority of obs_window config variables so that wrapper-specific version is preferred over generic OBS_WINDOW_BEGIN/END (#2062)
fix #2070 var list numeric order (#2072)
fix #2087 develop docs_pdf (#2091)
fix #2096/#2098 develop - fix skip if output exists and do not error if no commands were run (#2099)
georgemccabe pushed a commit that referenced this issue Apr 28, 2023
Co-authored-by: Julie Prestopnik <[email protected]>
Co-authored-by: johnhg <[email protected]>
Co-authored-by: cristianastan2 <[email protected]>
Co-authored-by: John Halley Gotway <[email protected]>
Co-authored-by: bikegeek <[email protected]>
Co-authored-by: Lisa Goodrich <[email protected]>
Co-authored-by: Julie Prestopnik <[email protected]>
Co-authored-by: George McCabe <[email protected]>
Co-authored-by: Hank Fisher <[email protected]>
Co-authored-by: Dan Adriaansen <[email protected]>
Co-authored-by: jprestop <[email protected]>
Co-authored-by: Tracy Hertneky <[email protected]>
Co-authored-by: Giovanni Rosa <[email protected]>
Co-authored-by: j-opatz <[email protected]>
Co-authored-by: lisagoodrich <[email protected]>
Co-authored-by: bikegeek <[email protected]>
Co-authored-by: j-opatz <[email protected]>
Co-authored-by: Will Mayfield <[email protected]>
Co-authored-by: metplus-bot <[email protected]>
Co-authored-by: Tracy Hertneky <[email protected]>
Co-authored-by: Giovanni Rosa <[email protected]>
fixing errors #650
fixing errors take 2 #650
fixing errors take 3 #650
fixing errors take 4 #650
fixing errors take 5 #650
fixing question order #650
fix #1706 fix PhaseDiagram use case to avoid writing into INPUT_BASE (#1708)
fix #1713 develop METPLOTPY_BASE (#1715)
fix #1691 remove whitespace from output file paths (#1721)
fix Contributor's Guide GitHub Workflow page (#1774)
fix release (#1790)
fix GitHub Actions warnings (#1864)
fix #1884 develop PCPCombine {custom} in subtract method (#1887)
fix #1939 develop - failure reading obs when zipped file also exists (#1941)
Closes #1986
fix develop Fix broken documentation links (#2004)
fix #2026 develop StatAnalysis looping (#2028)
fix priority of obs_window config variables so that wrapper-specific version is preferred over generic OBS_WINDOW_BEGIN/END (#2062)
fix #2070 var list numeric order (#2072)
fix #2087 develop docs_pdf (#2091)
fix #2096/#2098 develop - fix skip if output exists and do not error if no commands were run (#2099)
Fix for Dockerfile smell DL4000 (#2112)
fix #2082 develop regrid.convert/censor_thresh/censor_val (#2140)
fix #2082 main_v5.0 regrid.convert/censor_thresh/censor_val (#2101)
fix #2137 develop PointStat -obs_valid_beg/end (#2141)
JohnHalleyGotway pushed a commit that referenced this issue May 11, 2023
Co-authored-by: Julie Prestopnik <[email protected]>
Co-authored-by: johnhg <[email protected]>
Co-authored-by: cristianastan2 <[email protected]>
Co-authored-by: John Halley Gotway <[email protected]>
Co-authored-by: bikegeek <[email protected]>
Co-authored-by: Lisa Goodrich <[email protected]>
Co-authored-by: Julie Prestopnik <[email protected]>
Co-authored-by: George McCabe <[email protected]>
Co-authored-by: Hank Fisher <[email protected]>
Co-authored-by: Dan Adriaansen <[email protected]>
Co-authored-by: jprestop <[email protected]>
Co-authored-by: Tracy Hertneky <[email protected]>
Co-authored-by: Giovanni Rosa <[email protected]>
Co-authored-by: j-opatz <[email protected]>
Co-authored-by: lisagoodrich <[email protected]>
Co-authored-by: bikegeek <[email protected]>
Co-authored-by: j-opatz <[email protected]>
Co-authored-by: Will Mayfield <[email protected]>
Co-authored-by: metplus-bot <[email protected]>
Co-authored-by: Tracy Hertneky <[email protected]>
Co-authored-by: Giovanni Rosa <[email protected]>
fixing errors #650
fixing errors take 2 #650
fixing errors take 3 #650
fixing errors take 4 #650
fixing errors take 5 #650
fixing question order #650
fix #1706 fix PhaseDiagram use case to avoid writing into INPUT_BASE (#1708)
fix #1713 develop METPLOTPY_BASE (#1715)
fix #1691 remove whitespace from output file paths (#1721)
fix Contributor's Guide GitHub Workflow page (#1774)
fix release (#1790)
fix GitHub Actions warnings (#1864)
fix #1884 develop PCPCombine {custom} in subtract method (#1887)
fix #1939 develop - failure reading obs when zipped file also exists (#1941)
Closes #1986
fix develop Fix broken documentation links (#2004)
fix #2026 develop StatAnalysis looping (#2028)
fix priority of obs_window config variables so that wrapper-specific version is preferred over generic OBS_WINDOW_BEGIN/END (#2062)
fix #2070 var list numeric order (#2072)
fix #2087 develop docs_pdf (#2091)
fix #2096/#2098 develop - fix skip if output exists and do not error if no commands were run (#2099)
Fix for Dockerfile smell DL4000 (#2112)
fix #2082 develop regrid.convert/censor_thresh/censor_val (#2140)
fix #2082 main_v5.0 regrid.convert/censor_thresh/censor_val (#2101)
fix #2137 develop PointStat -obs_valid_beg/end (#2141)
fix failured introduced by urllib3 (see urllib3/urllib3#2168)
fix #2161 develop PCPCombine additional field arguments in -subtract mode (#2162)
georgemccabe pushed a commit that referenced this issue Jun 5, 2023
Co-authored-by: Julie Prestopnik <[email protected]>
Co-authored-by: johnhg <[email protected]>
Co-authored-by: cristianastan2 <[email protected]>
Co-authored-by: John Halley Gotway <[email protected]>
Co-authored-by: bikegeek <[email protected]>
Co-authored-by: Lisa Goodrich <[email protected]>
Co-authored-by: Julie Prestopnik <[email protected]>
Co-authored-by: George McCabe <[email protected]>
Co-authored-by: Hank Fisher <[email protected]>
Co-authored-by: Dan Adriaansen <[email protected]>
Co-authored-by: jprestop <[email protected]>
Co-authored-by: Tracy Hertneky <[email protected]>
Co-authored-by: Giovanni Rosa <[email protected]>
Co-authored-by: j-opatz <[email protected]>
Co-authored-by: Mrinal Biswas <[email protected]>
Co-authored-by: lisagoodrich <[email protected]>
Co-authored-by: bikegeek <[email protected]>
Co-authored-by: j-opatz <[email protected]>
Co-authored-by: Will Mayfield <[email protected]>
Co-authored-by: metplus-bot <[email protected]>
Co-authored-by: Tracy Hertneky <[email protected]>
Co-authored-by: Giovanni Rosa <[email protected]>
Co-authored-by: mrinalbiswas <[email protected]>
fixing errors #650
fixing errors take 2 #650
fixing errors take 3 #650
fixing errors take 4 #650
fixing errors take 5 #650
fixing question order #650
fix #1706 fix PhaseDiagram use case to avoid writing into INPUT_BASE (#1708)
fix #1713 develop METPLOTPY_BASE (#1715)
fix #1691 remove whitespace from output file paths (#1721)
fix Contributor's Guide GitHub Workflow page (#1774)
fix release (#1790)
fix GitHub Actions warnings (#1864)
fix #1884 develop PCPCombine {custom} in subtract method (#1887)
fix #1939 develop - failure reading obs when zipped file also exists (#1941)
Closes #1986
fix develop Fix broken documentation links (#2004)
fix #2026 develop StatAnalysis looping (#2028)
fix priority of obs_window config variables so that wrapper-specific version is preferred over generic OBS_WINDOW_BEGIN/END (#2062)
fix #2070 var list numeric order (#2072)
fix #2087 develop docs_pdf (#2091)
fix #2096/#2098 develop - fix skip if output exists and do not error if no commands were run (#2099)
Fix for Dockerfile smell DL4000 (#2112)
fix #2082 develop regrid.convert/censor_thresh/censor_val (#2140)
fix #2082 main_v5.0 regrid.convert/censor_thresh/censor_val (#2101)
fix #2137 develop PointStat -obs_valid_beg/end (#2141)
fix failured introduced by urllib3 (see urllib3/urllib3#2168)
fix #2161 develop PCPCombine additional field arguments in -subtract mode (#2162)
fix #2168 develop - StatAnalysis time shift (#2169)
fix releases. (#2183)
fix #2189 develop - spaces in complex thresholds (#2191)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation Documentation issue priority: medium Medium Priority reporting: DTC AF METplus Air Force METplus Project reporting: DTC NOAA BASE NOAA Office of Atmospheric Research DTC Project requestor: UK Met Office United Kingdom Met Office required: FOR OFFICIAL RELEASE Required to be completed in the official release for the assigned milestone type: enhancement Improve something that it is currently doing
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

3 participants