Skip to content

Fix installation instructions in User's Guide #1067

@georgemccabe

Description

@georgemccabe

Describe the Problem

The current installation instructions tell users to use the scripts in the build_components directory to install MET and other METplus components:

https://metplus.readthedocs.io/en/v4.0.0/Users_Guide/installation.html#build-components-and-using-manage-externals

However, the script does not work and produces many errors. There will be a separate issue to fix the scripts, but in the meantime we should update the documentation to direct users to download the latest release tarfile and refer to the installation instructions in chapter 2 of the MET User's Guide instead of using these scripts.

These changes should be applied to the main_v4.0 and develop branches.

A recent GitHub Discussions question brought this to attention: #1059

The comments of this discussion include info provided to the user to get MET installed that can be used as a reference to update the documentation.

Relevant Deadlines

ASAP

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 Organization level Project for support of the current coordinated release
  • Select Repository level Project for development toward the next official release or add alert: NEED PROJECT ASSIGNMENT label
  • Select Milestone as the next bugfix version

Define Related Issue(s)

Consider the impact to the other METplus components.

Bugfix 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 main_<Version>.
    Branch name: bugfix_<Issue Number>_main_<Version>_<Description>
  • Fix the bug 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 main_<Version>.
    Pull request: bugfix <Issue Number> main_<Version> <Description>
  • Define the pull request metadata, as permissions allow.
    Select: Reviewer(s) and Linked issues
    Select: Organization level software support Project for the current coordinated release
    Select: Milestone as the next bugfix version
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Complete the steps above to fix the bug on the develop branch.
    Branch name: bugfix_<Issue Number>_develop_<Description>
    Pull request: bugfix <Issue Number> develop <Description>
    Select: Reviewer(s) and Linked issues
    Select: Repository level development cycle Project for the next official release
    Select: Milestone as the next official version
  • Close this issue.

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions