Modify Requirements section of the User's Guide

[jprestop]

Describe the Task

Modify the Requirements section of the User's Guide so that the information is not listed directly, but rather so that there is use of a literalinclude linking to the requirements.txt file, which will automatically stay updated.

@lisagoodrich, this repository differs slightly from METplotpy and METcalcpy. The text under Requirements about Python, currently states:

Python 3.10.4+ - Python 3.10.4 or higher must be installed. METdataio also requires the Python packages pymysql, pandas, numpy, pyyaml, and lxml. Please refer to the requirements.txt file for the version numbers.

Please create a subcategory of. "Requirements" called "Python Requirements" and then use the literal include like you did for METplotpy and METcalcpy. Please let me know if you have any questions.

As an example, refer to the METplus User's Guide. See this line in the PointStat.py which uses RST's .. literalinclude:: and renders on the web in what appears to be a code block in this section.

Time Estimate

<1 day of work

Sub-Issues

Consider breaking the task down into sub-issues.

• [ ] Add a checkbox for each sub-issue here.

Relevant Deadlines

METdataio-3.0.0 release

Funding Source

Split across accounts (@lisagoodrich let me know if you have any questions) 2702691 JNT DTC NSF BASE FUN… 2784543 NOAA R2O METp SW2 2799991 Met Office METplus S…

Assignee

• [x] Select engineer(s) or no engineer required
• [ ] Select scientist(s) or no scientist required

Labels

• [x] Select component(s)
• [x] Select priority
• [x] Select requestor(s)

Projects and Milestone

• [x] Select Repository and/or Organization level Project(s) or add alert: NEED CYCLE ASSIGNMENT label
• [x] Select Milestone as the next official version or Future Versions

Define Related Issue(s)

Consider the impact to the other METplus components.

• [ ] METplus, MET, METdataio, METviewer, METexpress, METcalcpy, METplotpy

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.
• [ ] Add any new Python packages to the METplus Components Python Requirements table.
• [ ] 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.