Documentation: Add METplus Components Installation Instructions to the Documentation

[bikegeek]

Describe the Task

METviewer has been historically been updated/installed on various hosts by one developer. Detailed instructions need to be added to the METplus documentation (location to be determined) to enable other developers to perform updates/installations.

This will likely impact the other METplus Analysis Tools repositories (i.e. METdataio, METcalcpy, METplotpy).

Documentation should also be written up describing the installations that are performed for all of the METplus components and are listed on the Existing Builds page.

This information will likely go into a new section of the Release Guide.

Time Estimate

Estimate the amount of work required here.
Issues should represent approximately 1 to 3 days of work.

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.

[georgemccabe]

Should this issue belong in the METviewer repository since it will likely be added to the METviewer documentation?

[bikegeek]

I think we were going to put this in the Release Guide? It's still up for debate. Julie needs some time to consider where to put this. I put the issue here so it has a high-visibility 'home', we are amenable to moving it. --------------- 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, Mar 7, 2024 at 11:38 AM George McCabe ***@***.***> wrote: Should this issue belong in the METviewer repository since it will likely be added to the METviewer documentation? — Reply to this email directly, view it on GitHub <#2510 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AA4UJHWPIEZ4WK5P5EGQNGDYXCX3ZAVCNFSM6AAAAABEJY4X6CVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSOBUGE4TENBZG4> . You are receiving this because you were assigned.Message ID: ***@***.***>

[jprestop]

Hi @georgemccabe. You're also missing some context from the meeting where we discussed this work. I just added to the description the following information:

Documentation should also be written up describing the installations that are performed for all of the METplus components and are listed on the Existing Builds page.

This information will likely go into a new section of the Release Guide.

[georgemccabe]

Thank you for clarifying, @bikegeek and @jprestop

[jprestop]

Regarding instructions for installing METviewer, @TatianaBurek mentioned via email that she doesn't currently have any written instructions and would need to find the time, correct location (METplus Release Guide???), and have a project key to create them. We would need to talk with @TaraJensen about an account key, ensure @TatianaBurek has time, and finalize a location (I can't remember why we talked about putting this in the Release Guide and would like some further discussion with the team regarding the details on that and receive clarification on how the METviewer instructions impact the other METplus Analysis Tools repositories, so as a result, I just added the ALERT: NEED MORE DEFINITION label).