From 73ccfed72d67acfdbf0aa469567eaf48970602b1 Mon Sep 17 00:00:00 2001 From: Soren Rasmussen Date: Wed, 11 Sep 2024 15:02:07 -0600 Subject: [PATCH] Updating README for v7 and adding build badges. Renaming github action so badge says 'build' --- .github/workflows/ci_scm_ccpp_prebuild.yml | 3 ++- README.md | 16 ++++++++++++++-- 2 files changed, 16 insertions(+), 3 deletions(-) diff --git a/.github/workflows/ci_scm_ccpp_prebuild.yml b/.github/workflows/ci_scm_ccpp_prebuild.yml index fbcaa169d..662aa267c 100644 --- a/.github/workflows/ci_scm_ccpp_prebuild.yml +++ b/.github/workflows/ci_scm_ccpp_prebuild.yml @@ -1,4 +1,5 @@ -name: CI test to run SCM ccpp_prebuild script +# CI test to run SCM ccpp_prebuild script +name: build on: [push, pull_request, workflow_dispatch] diff --git a/README.md b/README.md index 0db822ec2..82f0a6759 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,15 @@ -# User's Guide +# Single Column Model (SCM) -Please find the up-to-date User's Guide located on ReadTheDocs: https://ccpp-scm.readthedocs.io/en/latest/ +[![Build Status](https://github.com/NCAR/ccpp-scm/actions/workflows/ci_scm_ccpp_prebuild.yml/badge.svg?branch=main)](https://github.com/NCAR/ccpp-scm/actions/workflows/ci_scm_ccpp_prebuild.yml) +[![Release](https://img.shields.io/github/release/NCAR/ccpp-scm.svg)](https://github.com/NCAR/ccpp-scm/releases/latest) +[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13156711.svg)](https://doi.org/10.5281/zenodo.13156711) + + +The SCM is a tool for developing physics suites and diagnosing their performance. This SCM works with the +- [Common Community Physics Package (CCPP):](https://github.com/NCAR/ccpp-physics) a library of physical parameterizations for atmospheric numerical models. +- [CCPP Framework:](https://github.com/NCAR/ccpp-scm:) a framework for connecting atmospheric models to physics suites. + +## Documentation +- [SCM readthedocs](https://ccpp-scm.readthedocs.io/en/v7.0.0/) +- [CCPP readthedocs](https://ccpp-techdoc.readthedocs.io/en/v7.0.0/) +- [Scientific Documentation](https://dtcenter.ucar.edu/GMTB/v7.0.0/sci_doc/index.html)