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

Feature dtcenter/METplus-Internal#15 add checksum to release #2254

Merged
merged 6 commits into from
Sep 14, 2022
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .github/workflows/release-checksum.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Add checksum to release

on:
release:
types:
- published

jobs:
add-checksum:
runs-on: ubuntu-latest
steps:
- uses: dtcenter/metplus-action-release-checksum@v1
with:
token: ${{ secrets.METPLUS_BOT_TOKEN }}
32 changes: 28 additions & 4 deletions docs/Users_Guide/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ NCEP's BUFRLIB is written entirely in Fortran. The portion of MET that handles t

The MET package is intended to be a tool for the modeling community to use and adapt. As users make upgrades and improvements to the tools, they are encouraged to offer those upgrades to the broader community by offering feedback to the developers.

Required Compilers and Acripting Languages
Required Compilers and Scripting Languages
==========================================

The MET package was developed and tested using the GNU g++/gfortran compilers and the Intel icc/ifort compilers. As additional compilers are successfully tested, they will be added to the list of supported platforms/compilers.
Expand All @@ -38,8 +38,8 @@ In order to control the desired flow through MET, users are encouraged to run th

.. _Install_Required-libraries-and:

Required Libraries and Optional U1tilities
==========================================
Required Libraries and Optional Utilities
=========================================

Three external libraries are required for compiling/building MET and should be downloaded and installed before attempting to install MET. Additional external libraries required for building advanced features in MET are discussed in :numref:`Installation-of-required` :

Expand Down Expand Up @@ -143,8 +143,32 @@ Building the MET Package

Building the MET package consists of three main steps: (1) install the required libraries, (2) configure the environment variables, and (3) configure and execute the build. Users can follow the instructions below or use a sample installation script. Users can find the script and its instructions under on the `Downloads <https://dtcenter.org/community-code/model-evaluation-tools-met/download>`_ page of the MET website.

Get the MET source code
-----------------------

The MET source code is available for download from the public `MET GitHub repository <https://github.com/dtcenter/MET>`_.

- Open a web browser and go to the `latest stable MET release <https://github.com/dtcenter/MET/releases/latest>`_.

- Click on the `Source code` link (either the *zip* or *tar.gz*) under Assets and when prompted, save it to your machine.

- (Optional) Verify the checksum of the source code download

- Download the checksum file that corresponds to the source code download link that was used (checksum_zip.txt for the *zip* file and checksum_tar.txt for the *tar.gz* file). Put the checksum file into the same directory as the source code file.
- Run the *sha256sum* command with the --check argument to verify that the source code download file was not corrupted.

Zip File::

sha256sum --check checksum_zip.txt

Tar File::

sha256sum --check checksum_tar.txt

georgemccabe marked this conversation as resolved.
Show resolved Hide resolved
- Uncompress the source code (on Linux/Unix\ *: gunzip* for zip file or *tar xvfz* for the tar.gz file)

Install the Required Libraries
==============================
------------------------------

• Please refer to :numref:`Installation-of-required` and :numref:`Installation-of-optional` on how to install the required and optional libraries.

Expand Down