From 437318f611a28b1f0c8dcd87fb2208e3b311c1bb Mon Sep 17 00:00:00 2001
From: Tom Bendall <thomas.bendall@metoffice.gov.uk>
Date: Sun, 11 Aug 2024 18:38:19 +0100
Subject: [PATCH] update template

---
 .github/pull_request_template.md |  5 ++++-
 README.md                        | 19 ++++++++++++++++++-
 2 files changed, 22 insertions(+), 2 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index fe8a43c..3b83cb6 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -17,7 +17,10 @@ the repository:
 
 # Add or update a plotting script
 Here is a checklist of things that should be done to add a new plotting script to the repository:
-- [ ] The plotting script has been prepared from the template in `templates/template_plot.py`
+- [ ] The plotting script has been prepared from the template in `templates/template_plot.py` or another acceptable plotting script
+- [ ] The plot follows the Good Plot Guide in [`tomplot/good_plot_guide.md`](https://github.com/tommbendall/tomplot/blob/main/good_plot_guide.md)
+- [ ] Relevant initial and final fields are plotted
+- [ ] The figures produced have been added to the repository
 
 <!--
 Here is a comment that can include verbose instructions that will not
diff --git a/README.md b/README.md
index 1c96775..3ffdd3e 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,18 @@
-A repository for holding scripts setting up working case studies for Gusto.
\ No newline at end of file
+# Gusto Case Studies
+
+Welcome to the Gusto Case Studies repository!
+
+This stores a collection of Python scripts which implement standard (and more exotic) test cases for geophysical fluids, particularly those used in the development of the dynamical cores used in numerical weather prediction models.
+
+The test cases are run using the [Gusto](https://www.firedrakeproject.org/gusto/) code library, which uses compatible finite element methods to discretise the fluid's equations of motion.
+Gusto is built upon the [Firedrake](https://www.firedrakeproject.org/) software, which provides the finite element infrastructure used by Gusto.
+
+Case studies are organised by governing equation. Each case study is accompanied by a plotting script, and reference figures.
+
+Our continuous integration is intended to ensure that this repository runs at the Gusto head-of-trunk.
+
+## Visualisation
+
+Gusto can produce output in two formats:
+- VTU files, which can be viewed with the [Paraview](https://www.paraview.org/) software
+- netCDF files, which has data that can be plotted using standard python packages such as matplotlib. We suggest using the [tomplot](https://github.com/tommbendall/tomplot) python library, which contains several routines to simplify the plotting of Gusto output.