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

Revise TC-Diag documentation for version 11.1.0 #2558

Closed
7 of 20 tasks
JohnHalleyGotway opened this issue Jun 7, 2023 · 1 comment · Fixed by #2580 or #2625
Closed
7 of 20 tasks

Revise TC-Diag documentation for version 11.1.0 #2558

JohnHalleyGotway opened this issue Jun 7, 2023 · 1 comment · Fixed by #2580 or #2625
Assignees
@JohnHalleyGotway
Labels
component: documentation Documentation issue priority: high High Priority requestor: METplus Team METplus Development Team type: task An actionable item of work
Milestone
MET 11.1.0

Comments

@JohnHalleyGotway
Copy link
Collaborator

Describe the Task

#2168 added the initial version of the TC-Diag tool. While it does include some initial documentation, it is not thorough or completely accurate. This task is to review and revise that documentation prior to the 11.1.0 release.

Time Estimate

4 hours.

Sub-Issues

Consider breaking the task down into sub-issues.
None needed.

Relevant Deadlines

Version 11.1.0 release.

Funding Source

2770043

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 CYCLE ASSIGNMENT label
  • Select Milestone as the next official version or Future Versions

Define Related Issue(s)

Consider the impact to the other METplus components.

Task 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 Development 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.
@JohnHalleyGotway JohnHalleyGotway added component: documentation Documentation issue type: task An actionable item of work requestor: METplus Team METplus Development Team priority: high High Priority labels Jun 7, 2023
@JohnHalleyGotway JohnHalleyGotway added this to the MET 11.1.0 milestone Jun 7, 2023
@JohnHalleyGotway JohnHalleyGotway self-assigned this Jun 7, 2023
@JohnHalleyGotway JohnHalleyGotway mentioned this issue Jun 7, 2023
Merged
15 tasks
JohnHalleyGotway added a commit that referenced this issue Jun 15, 2023
@JohnHalleyGotway
Per #2558, change TC-DIAG to TC-Diag and consistently use TC-DLand.
bc63fbf
JohnHalleyGotway added a commit that referenced this issue Jun 15, 2023
@JohnHalleyGotway
Per #2558, update the flowchart for 11.1.0 and describe TC-Diag in th…
0c8c0c8 
…e overview section.
JohnHalleyGotway added a commit that referenced this issue Jun 19, 2023
@JohnHalleyGotway
Per #2558, update the user's guide chapter about TC-Diag
13a72e4
@JohnHalleyGotway JohnHalleyGotway linked a pull request Jun 19, 2023 that will close this issue
Feature #2558 tc_diag_docs #2580
Merged
15 tasks
jvigh added a commit that referenced this issue Jun 22, 2023
@jvigh
As per #2558, adding some changes to the documentation. Added more ov…
c153962 
…erview and background on the TC-Diag tool and the purpose of diagnostics. Added subsubheadings for the config sections.
JohnHalleyGotway added a commit that referenced this issue Jul 10, 2023
@JohnHalleyGotway
Per #2558, replace ATCFID with TECH
8c5df2e
JohnHalleyGotway added a commit that referenced this issue Jul 10, 2023
@JohnHalleyGotway
Feature #2558 tc_diag_docs (#2580)
f10845a 
Co-authored-by: John Halley Gotway <johnhg@ucar.edu>
Co-authored-by: Seth Linden <linden@seneca.rap.ucar.edu>
Co-authored-by: jprestop <jpresto@ucar.edu>
Co-authored-by: Daniel Adriaansen <dadriaan@ucar.edu>
Co-authored-by: John and Cindy <halleygotway@Halleys-Mac-mini.local>
Co-authored-by: Howard Soh <hsoh@seneca.rap.ucar.edu>
Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>
Co-authored-by: hsoh-u <hsoh@ucar.edu>
Co-authored-by: MET Tools Test Account <met_test@seneca.rap.ucar.edu>
Co-authored-by: Seth Linden <linden@ucar.edu>
Co-authored-by: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com>
Co-authored-by: davidalbo <dave@ucar.edu>
Co-authored-by: Lisa Goodrich <lisag@ucar.edu>
Co-authored-by: metplus-bot <97135045+metplus-bot@users.noreply.github.com>
Co-authored-by: j-opatz <59586397+j-opatz@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Jonathan Vigh <jvigh@ucar.edu>
Fix Python environment issue (#2407)
fix definitions of G172 and G220 based on comments in NOAA-EMC/NCEPLIBS-w3emc#157. (#2406)
fix #2380 develop override (#2382)
fix #2408 develop empty config (#2410)
fix #2390 develop compile zlib (#2404)
fix #2412 develop climo (#2422)
fix #2437 develop convert (#2439)
fix for develop, for #2437, forgot one reference to the search_parent for a dictionary lookup.
fix #2452 develop airnow (#2454)
fix #2449 develop pdf (#2464)
fix #2402 develop sonarqube (#2468)
fix #2426 develop buoy (#2475)
fix 2518 dtypes appf docs (#2519)
fix 2531 compilation errors (#2533)
fix #2531 compilation_errors_configure (#2535)
@JohnHalleyGotway
Copy link
Collaborator Author

Re-opening this issue since @jvigh has edits from @musgrave-kate to incorporate.

jvigh added a commit that referenced this issue Jul 25, 2023
@jvigh
As per #2558, making changes to incorporate Kate Musgrave's feedback …
ca8e60d 
…on the TC-Diag tool documentation.
@JohnHalleyGotway JohnHalleyGotway linked a pull request Jul 25, 2023 that will close this issue
Feature #2558 tc_diag_docs edits #2625
Merged
15 tasks
JohnHalleyGotway added a commit that referenced this issue Jul 25, 2023
@JohnHalleyGotway
Feature #2558 tc_diag_docs edits (#2625)
c32f4ed 
Co-authored-by: John Halley Gotway <johnhg@ucar.edu>
Co-authored-by: Seth Linden <linden@seneca.rap.ucar.edu>
Co-authored-by: jprestop <jpresto@ucar.edu>
Co-authored-by: Daniel Adriaansen <dadriaan@ucar.edu>
Co-authored-by: John and Cindy <halleygotway@Halleys-Mac-mini.local>
Co-authored-by: Howard Soh <hsoh@seneca.rap.ucar.edu>
Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>
Co-authored-by: hsoh-u <hsoh@ucar.edu>
Co-authored-by: MET Tools Test Account <met_test@seneca.rap.ucar.edu>
Co-authored-by: Seth Linden <linden@ucar.edu>
Co-authored-by: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com>
Co-authored-by: davidalbo <dave@ucar.edu>
Co-authored-by: Lisa Goodrich <lisag@ucar.edu>
Co-authored-by: metplus-bot <97135045+metplus-bot@users.noreply.github.com>
Co-authored-by: j-opatz <59586397+j-opatz@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Jonathan Vigh <jvigh@ucar.edu>
Fix Python environment issue (#2407)
fix definitions of G172 and G220 based on comments in NOAA-EMC/NCEPLIBS-w3emc#157. (#2406)
fix #2380 develop override (#2382)
fix #2408 develop empty config (#2410)
fix #2390 develop compile zlib (#2404)
fix #2412 develop climo (#2422)
fix #2437 develop convert (#2439)
fix for develop, for #2437, forgot one reference to the search_parent for a dictionary lookup.
fix #2452 develop airnow (#2454)
fix #2449 develop pdf (#2464)
fix #2402 develop sonarqube (#2468)
fix #2426 develop buoy (#2475)
fix 2518 dtypes appf docs (#2519)
fix 2531 compilation errors (#2533)
fix #2531 compilation_errors_configure (#2535)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JohnHalleyGotway JohnHalleyGotway

Labels
component: documentation Documentation issue priority: high High Priority requestor: METplus Team METplus Development Team type: task An actionable item of work
Projects
No open projects
MET-11.1.0 Development
Status: ✅ Done
Milestone
MET 11.1.0
Development

Successfully merging a pull request may close this issue.

Feature #2558 tc_diag_docs dtcenter/MET
Feature #2558 tc_diag_docs edits dtcenter/MET
1 participant
@JohnHalleyGotway