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

Modify Python Requirements section of the User's Guide #352

Closed
6 of 22 tasks
jprestop opened this issue Feb 5, 2024 · 0 comments · Fixed by #355
Closed
6 of 22 tasks

Modify Python Requirements section of the User's Guide #352

jprestop opened this issue Feb 5, 2024 · 0 comments · Fixed by #355
Assignees
Labels
component: documentation Documentation issue priority: high High Priority requestor: METplus Team METplus Development Team type: task An actionable item of work

Comments

@jprestop
Copy link
Collaborator

jprestop commented Feb 5, 2024

Describe the Task

Modify the Python 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.

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.

Also put a note at the top:
The requirements below come directly from the requirements.txt file at the top level of the repository.

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

METcalcpy-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…

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.
  • 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.
@jprestop jprestop added component: documentation Documentation issue priority: high High Priority type: task An actionable item of work requestor: METplus Team METplus Development Team labels Feb 5, 2024
@jprestop jprestop added this to the METcalcpy-3.0.0 milestone Feb 5, 2024
@jprestop jprestop linked a pull request Feb 6, 2024 that will close this issue
14 tasks
@jprestop jprestop closed this as completed Feb 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation Documentation issue priority: high High Priority requestor: METplus Team METplus Development Team type: task An actionable item of work
Projects
Status: ✅ Done
Development

Successfully merging a pull request may close this issue.

2 participants