Documentation: Remove package versions in User's Guide Installation

[bikegeek]

Describe the Task

The only version of relevance is the Python version. Maintaining versions in multiple locations will result in confusion if the documentation is inconsistent with the requirements.txt. Refer the user to the requirements.txt instead with instructions for pip and conda installation using the requirements.txt

N.B.

opencv-python is the package name for pip installation
opencv is the package name for conda installation

Time Estimate

1 day

Sub-Issues

Consider breaking the task down into sub-issues.

• Add a checkbox for each sub-issue here.

Relevant Deadlines

List relevant project deadlines here or state NONE.

Funding Source

Define the source of funding and account keys here or state NONE.

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.

• 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.

[lisagoodrich]

@bikegeek or @fisherhucar would you have a couple minutes to meet and get me up to speed on this? I'm free until 4pm today. Thanks!

[bikegeek]

I want to point the requirements sections in the User's Guide to the requirements.txt file, like what was done in METcalcpy dtcenter/METcalcpy#352 --------------- Minna Win Pronouns: she/her NSF NCAR DTC & Research Applications Lab Phone: 303-497-8423 *My work hours may not be your work hours. Please do not feel obliged to reply to this email outside of your normal working hours.* ---------------

…

On Wed, Feb 28, 2024 at 2:16 PM lisagoodrich ***@***.***> wrote: @bikegeek <https://github.com/bikegeek> or @fisherhucar <https://github.com/fisherhucar> would you have a couple minutes to meet and get me up to speed on this? I'm free until 4pm today. Thanks! — Reply to this email directly, view it on GitHub <#412 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AA4UJHQ43HSFFVJZWOT5S5DYV6NBJAVCNFSM6AAAAABBNFUGJSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSNRZHEZDSMRWGM> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[lisagoodrich]

@bikegeek thanks for the clarification.
I just created a branch, Feature_412_remove_package_versions and I feel silly. I think this work has already been done. There is already a literal include in the develop branch. https://github.com/dtcenter/METplotpy/blob/develop/docs/Users_Guide/installation.rst.
Should I delete my branch and close the issue?
Or is there another place that also needs a "literal include"?
Thanks.

[bikegeek]

I found some hard-coded versions in the *polar ice-plot:* https://metplotpy.readthedocs.io/en/develop/Users_Guide/polar_plot.html the *s2s blocking*: https://metplotpy.readthedocs.io/en/develop/Users_Guide/s2s_blocking.html the *difficulty index*: https://metplotpy.readthedocs.io/en/develop/Users_Guide/difficulty_index.html *weather regime plots*: https://metplotpy.readthedocs.io/en/develop/Users_Guide/weather_regime.html *hovmoeller plot:* https://metplotpy.readthedocs.io/en/develop/Users_Guide/hovmoeller.html *spacetime (cross-spectra) plot*: https://metplotpy.readthedocs.io/en/develop/Users_Guide/spacetime.html *stratospheric diagnostics*: https://metplotpy.readthedocs.io/en/develop/Users_Guide/stratosphere_diagnostics.html *Could you please leave the package names in the documentation but remove the versions and add a link to the requirements.txt file with some text like: "For version numbers, please refer to <requirements.txt> "? * *Note* the physics tendency does have a hard-coded version for one package, but this is necessary. We can leave that documentation unedited. Thanks for working on this. Regards Minna --------------- Minna Win Pronouns: she/her NSF NCAR DTC & Research Applications Lab Phone: 303-497-8423 *My work hours may not be your work hours. Please do not feel obliged to reply to this email outside of your normal working hours.* ---------------

…

On Thu, Feb 29, 2024 at 4:05 PM lisagoodrich ***@***.***> wrote: @bikegeek <https://github.com/bikegeek> thanks for the clarification. I just created a branch, Feature_412_remove_package_versions and I feel silly. I think this work has already been done. There is already a literal include in the develop branch. https://github.com/dtcenter/METplotpy/blob/develop/docs/Users_Guide/installation.rst . Should I delete my branch and close the issue? Or is there another place that also needs a "literal include"? Thanks. — Reply to this email directly, view it on GitHub <#412 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AA4UJHVGSSVCZ7FKZSABH7DYV6Z2RAVCNFSM6AAAAABBNFUGJSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSNZSGEZDEMRZGY> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[jprestop]

@lisagoodrich Let me know if you have any questions about this work. I understand what Minna is asking for, so if it is not clear to you, I should be able to help.

@bikegeek, can you please clarify one point? Are the links above the only ones you want changed or are there others that perhaps you didn't link to that you also want changed and we should check all others (with the exclusion of the physics tendency which needs the hard-coded version for one package)?

[bikegeek]

I already went through the plot types and identified these as the ones that need changes. --------------- Minna Win Pronouns: she/her NSF NCAR DTC & Research Applications Lab Phone: 303-497-8423 *My work hours may not be your work hours. Please do not feel obliged to reply to this email outside of your normal working hours.* ---------------

…

On Fri, Mar 1, 2024 at 5:53 PM Julie Prestopnik ***@***.***> wrote: @lisagoodrich <https://github.com/lisagoodrich> Let me know if you have any questions about this work. I understand what Minna is asking for, so if it is not clear to you, I should be able to help. @bikegeek <https://github.com/bikegeek>, can you please clarify one point? Are the links above the only ones you want changed or are there others that perhaps you didn't link to that you also want changed and we should check all others (with the exclusion of the physics tendency which needs the hard-coded version for one package)? — Reply to this email directly, view it on GitHub <#412 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AA4UJHXRWQ2UD5YKAWMCCQTYWEPHFAVCNFSM6AAAAABBNFUGJSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSNZUGE2DKOBXG4> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[jprestop]

Perfect, @bikegeek! Thank you for letting us know!

[lisagoodrich]

@bikegeek I spoke with @jprestop about this and I need some clarification on the packages list in Required Packages section of the Polar Ice Plot. Here is a link to my branch:
https://metplotpy.readthedocs.io/en/develop/Users_Guide/polar_plot.html#required-packages
Version numbers for the following packages, along with the packages themselves, are not listed in the requirements.txt file but are listed as requirements.
metplotpy
cartopy
pyproj
pyresample
pillow
@jprestop suggests I stop work on this now, until we hear back from you, as she
thinks we are likely to encounter this problem with the other plots as well.

[bikegeek]

I'm pretty busy on some other deadlines, if you are OK with stopping this work, that is fine. --------------- Minna Win Pronouns: she/her NSF NCAR DTC & Research Applications Lab Phone: 303-497-8423 *My work hours may not be your work hours. Please do not feel obliged to reply to this email outside of your normal working hours.* ---------------

…

On Mon, Mar 4, 2024 at 12:12 PM lisagoodrich ***@***.***> wrote: @bikegeek <https://github.com/bikegeek> I spoke with @jprestop <https://github.com/jprestop> about this and I need some clarification on the packages list in Required Packages section of the Polar Ice Plot. Here is a link to my branch: https://metplotpy.readthedocs.io/en/develop/Users_Guide/polar_plot.html#required-packages Version numbers for the following packages, along with the packages themselves, are not listed in the requirements.txt file but are listed as requirements. metplotpy cartopy pyproj pyresample pillow @jprestop <https://github.com/jprestop> suggests I stop work on this now, until we hear back from you, as she thinks we are likely to encounter this problem with the other plots as well. — Reply to this email directly, view it on GitHub <#412 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AA4UJHWIVBWJABIFHTHWEBDYWTBQNAVCNFSM6AAAAABBNFUGJSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSNZXGI3TSNJZHE> . You are receiving this because you were mentioned.Message ID: ***@***.***>