Update the MET User's Guide to specify the data types in each output line type table

[JohnHalleyGotway]

Describe the Task

As requested by @randytpierce via an email to @JohnHalleyGotway on Dec 5, 2024, update the MET User's Guide to add a new column to the output line type tables to indicate the data type. Basically, indicate whether each output column contains an integer, float, or string. This information makes it clear and obvious to users how the data from each output column should be parsed.

Time Estimate

4 hours? -- if this strays more than a day, please contact @michelleharrold

Sub-Issues

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

Relevant Deadlines

List relevant project deadlines here or state NONE.

Funding Source

2782544 (NOAA Base)

Define the Metadata

Assignee

• Select engineer(s) or no engineer required
• Select scientist(s) or no scientist required

Labels

• Review default alert labels
• Select component(s)
• Select priority
• Select requestor(s)

Milestone and Projects

• Select Milestone as a MET-X.Y.Z version, Consider for Next Release, or Backlog of Development Ideas
• For a MET-X.Y.Z version, select the MET-X.Y.Z Development project

Define Related Issue(s)

Consider the impact to the other METplus components.

• METplus, MET, METdataio, METviewer, METexpress, METcalcpy, METplotpy
• No impacts.

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 issue
  Select: Milestone as the next official version
  Select: MET-X.Y.Z Development project for development toward the next official release
• Iterate until the reviewer(s) accept and merge your changes.
• Delete your fork or branch.
• Close this issue.

[JohnHalleyGotway]

@michelleharrold can you please advise on this issue? It's currently in "Needs Triage" state. Do we have funding to support these changes to include them in the official MET-12.0.0 release, currently slated for next Wednesday, Dec 18, 2024?

[michelleharrold]

@JohnHalleyGotway -- I added a key. If this starts to stray too far from the estimated time, please lmk! Thanks!

[JohnHalleyGotway]

@randytpierce, I'm going to work on these documentation updates today. Starting with this table and modifying the subsequent line type ones, my plan is to add a new Data Type column to the right side of the table. The value for each row of the table will be:

• "String" for character strings
• "Datetime String" for character strings formatted as YYYYMMDD[_YY[MMDD]]
• "Threshold String" for formatted threshold strings like >35
• "Integer" for all integer numbers
• "Double" for all double-precision numbers

I compared to the contents of the METdataio schema which does include details like maximum string length (e.g. model VARCHAR(80)) and signed vs unsigned integers (e.g. interp_pnts INT UNSIGNED). I do NOT think that level of detail is warranted here. MET doesn't actually limit the length of the model string. It's the database that does.

Just wanted to check with you to confirm that this level of detail meets your needs. Were you looking for anything in addition to or other than this?

[randytpierce]

This sounds wonderful, actually! thanks, randy

…

On Tue, Dec 17, 2024 at 11:50 AM John Halley Gotway < ***@***.***> wrote: @randytpierce <https://github.com/randytpierce>, I'm going to work on these documentation updates today. Starting with this table <https://met.readthedocs.io/en/main_v12.0/Users_Guide/point-stat.html#id5> and modifying the subsequent line type ones, my plan is to add a new Data Type column to the right side of the table. The value for each column will be: - "String" for character strings - "Datetime String" for character strings formatted as YYYYMMDD[_YY[MMDD]] - "Threshold String" for formatted threshold strings like >35 - "Integer" for all integer numbers - "Double" for all double-precision numbers I compared to the contents of the METdataio schema <https://github.com/dtcenter/METdataio/blob/develop/METdbLoad/sql/mv_mysql.sql> which does include details like expected string length (e.g. model VARCHAR(80)) and signed vs unsigned integers (e.g. interp_pnts INT UNSIGNED). I do NOT think that level of detail is warranted here. MET doesn't actually limit the length of the model string. It's the database that does. Just wanted to check with you to confirm that this level of detail meets your needs. Or were you looking for anything in addition or other than this? — Reply to this email directly, view it on GitHub <#3032 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AGDVQPRAPDW5UUCQUG7GKH32GBW6VAVCNFSM6AAAAABTGNHIVWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDKNBZGMZDQMZSGE> . You are receiving this because you were mentioned.Message ID: ***@***.***>

-- Randy Pierce