From ccb9fa7c31c2b3d7427b5cb8921e660575374430 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 badges --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0db822ec2..bded927b6 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,21 @@ -# 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/build_and_push_docker_latest.yml/badge.svg?branch=main)](https://github.com/NCAR/ccpp-scm/actions/workflows/build_and_push_docker_latest.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 single-column model (SCM) is a valuable tool for diagnosing the performance +of a physics suite. From validating that schemes have been integrated into a +suite to deep dives into how physical processes are being represented by the +approximating code. This SCM has the advantage of working with and being +developed alongside the [Common Community Physics Package](https://github.com/NCAR/ccpp-physics) +(CCPP), a library of physical parameterizations for atmospheric numerical +models, and the [CCPP Framework](https://github.com/NCAR/ccpp-scm). A +framework for connecting atmospheric models to physics suites constructed from +its member parameterizations. + +## Documentation +[Scientific Documentation](https://dtcenter.ucar.edu/GMTB/v7.0.0/sci_doc/index.html) +[SCM readthedocs](https://ccpp-scm.readthedocs.io/en/v7.0.0/) +[CCPP readthedocs](https://ccpp-techdoc.readthedocs.io/en/v7.0.0/)