From e5490d5bb209b4f9f7ad6a0999ada67b438a1874 Mon Sep 17 00:00:00 2001 From: Sylvia Bohnenstengel <62748926+Sylviabohnenstengel@users.noreply.github.com> Date: Mon, 16 Oct 2023 14:18:31 +0100 Subject: [PATCH 1/6] Update README.md adding information around what CSET provides. --- README.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ed7d23de1..c90eaa316 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,7 @@ # CSET -CSET is a toolkit for evaluation and investigation of numerical models for -weather and climate applications. It aims to replace the collection of bespoke -scripts littering people’s home directories, reducing effort wasted on -duplicating already existing code. This centralisation of diagnostics should -also make evaluations more consistent and comparable. Development takes place in +CSET is a toolkit for verification, evaluation and investigation of convective- and turbulence-scale numerical models for +weather and climate applications cutting across time and space scales. It aims to align parametrisation, diagnostic development and evaluation research linked to Met Office Research Atmosphere Land suites (RAL) across the Met Office and UM partnership. Apart from verification capabilities it focusses on providing and continuously developing a centralised source of tools to aid process-oriented evaluation for UM and LFRic systems supporting deterministic models and ensembles. It supports community development of well documented and peer reviewed evaluation tools and provides a legacy for diagnostics and observations. It offers flexible evaluation code that users can easily adapt according to their needs. It is build on a modern software stack using Python3 and Met+ in a conda environment to support portability. Clear documentation, working practices, automatic testing, and open access ensure developers can easily use and contribute to this system. Development takes place in the CSET repository on GitHub. Please read [the documentation](https://metoffice.github.io/CSET) to learn more From 0057c756df179145a0836cf7e32fe9e49c93ed96 Mon Sep 17 00:00:00 2001 From: James Frost Date: Mon, 16 Oct 2023 17:11:23 +0100 Subject: [PATCH 2/6] Reflow added text --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c90eaa316..df0f06de3 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,21 @@ # CSET -CSET is a toolkit for verification, evaluation and investigation of convective- and turbulence-scale numerical models for -weather and climate applications cutting across time and space scales. It aims to align parametrisation, diagnostic development and evaluation research linked to Met Office Research Atmosphere Land suites (RAL) across the Met Office and UM partnership. Apart from verification capabilities it focusses on providing and continuously developing a centralised source of tools to aid process-oriented evaluation for UM and LFRic systems supporting deterministic models and ensembles. It supports community development of well documented and peer reviewed evaluation tools and provides a legacy for diagnostics and observations. It offers flexible evaluation code that users can easily adapt according to their needs. It is build on a modern software stack using Python3 and Met+ in a conda environment to support portability. Clear documentation, working practices, automatic testing, and open access ensure developers can easily use and contribute to this system. Development takes place in -the CSET repository on GitHub. +CSET is a toolkit for verification, evaluation and investigation of convective- +and turbulence-scale numerical models for weather and climate applications +cutting across time and space scales. + +It aims to align parametrisation, diagnostic development and evaluation research +linked to Met Office Research Atmosphere Land suites (RAL) across the Met Office +and UM partnership. Apart from verification capabilities it focusses on +providing and continuously developing a centralised source of tools to aid +process-oriented evaluation for UM and LFRic systems supporting deterministic +models and ensembles. It supports community development of well documented and +peer reviewed evaluation tools and provides a legacy for diagnostics and +observations. It offers flexible evaluation code that users can easily adapt +according to their needs. It is build on a modern software stack using Python3 +and Met+ in a conda environment to support portability. Clear documentation, +working practices, automatic testing, and open access ensure developers can +easily use and contribute to this system. Please read [the documentation](https://metoffice.github.io/CSET) to learn more about CSET, and how to use it. From e0c32faab43522be3f68eb82321b9e6b9c1dec1e Mon Sep 17 00:00:00 2001 From: James Frost Date: Mon, 16 Oct 2023 17:14:34 +0100 Subject: [PATCH 3/6] Add aims to documentation --- README.md | 2 +- docs/source/background/why-cset.rst | 18 +++++++++++++++--- 2 files changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index df0f06de3..58de960a5 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ peer reviewed evaluation tools and provides a legacy for diagnostics and observations. It offers flexible evaluation code that users can easily adapt according to their needs. It is build on a modern software stack using Python3 and Met+ in a conda environment to support portability. Clear documentation, -working practices, automatic testing, and open access ensure developers can +working practices, automatic testing, and open access ensure developers can easily use and contribute to this system. Please read [the documentation](https://metoffice.github.io/CSET) to learn more diff --git a/docs/source/background/why-cset.rst b/docs/source/background/why-cset.rst index 6c457eaa2..605e1586c 100644 --- a/docs/source/background/why-cset.rst +++ b/docs/source/background/why-cset.rst @@ -15,8 +15,20 @@ CSET is a centralised place for custom diagnostics to live, with well defined :doc:`/contributing/index` to ensure that they stay maintained. By contributing diagnostics to CSET you ensure that they outlive the paper they were written for, and benefit the entire modelling community. Furthermore, any operators that -the community finds especially useful will be contributed back to -METplus_, so they can serve an -even wider community. +the community finds especially useful will be contributed back to METplus_, so +they can serve an even wider community. + +It aims to align parametrisation, diagnostic development and evaluation research +linked to Met Office Research Atmosphere Land suites (RAL) across the Met Office +and UM partnership. Apart from verification capabilities it focusses on +providing and continuously developing a centralised source of tools to aid +process-oriented evaluation for UM and LFRic systems supporting deterministic +models and ensembles. It supports community development of well documented and +peer reviewed evaluation tools and provides a legacy for diagnostics and +observations. It offers flexible evaluation code that users can easily adapt +according to their needs. It is build on a modern software stack using Python3 +and Met+ in a conda environment to support portability. Clear documentation, +working practices, automatic testing, and open access ensure developers can +easily use and contribute to this system. .. _METplus: https://dtcenter.org/community-code/metplus From e5696710029d27ebecb4ead05251fe1d72bd60f9 Mon Sep 17 00:00:00 2001 From: James Frost Date: Mon, 16 Oct 2023 17:18:43 +0100 Subject: [PATCH 4/6] Remove trailing whitespace --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 58de960a5..a039354d2 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ observations. It offers flexible evaluation code that users can easily adapt according to their needs. It is build on a modern software stack using Python3 and Met+ in a conda environment to support portability. Clear documentation, working practices, automatic testing, and open access ensure developers can -easily use and contribute to this system. +easily use and contribute to this system. Please read [the documentation](https://metoffice.github.io/CSET) to learn more about CSET, and how to use it. From f9d2f08deb139126fe5aa48fa92741d502ea1630 Mon Sep 17 00:00:00 2001 From: James Frost Date: Tue, 17 Oct 2023 15:04:48 +0000 Subject: [PATCH 5/6] Break up description and move to README --- README.md | 29 ++++++++++++++++------------- docs/source/background/why-cset.rst | 13 ------------- docs/source/index.rst | 17 +++++++++-------- 3 files changed, 25 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index a039354d2..e822ecc89 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,24 @@ -# CSET +# CSET (Convective and turbulence scale Evaluation and verification Toolkit) CSET is a toolkit for verification, evaluation and investigation of convective- and turbulence-scale numerical models for weather and climate applications cutting across time and space scales. -It aims to align parametrisation, diagnostic development and evaluation research -linked to Met Office Research Atmosphere Land suites (RAL) across the Met Office -and UM partnership. Apart from verification capabilities it focusses on -providing and continuously developing a centralised source of tools to aid -process-oriented evaluation for UM and LFRic systems supporting deterministic -models and ensembles. It supports community development of well documented and -peer reviewed evaluation tools and provides a legacy for diagnostics and -observations. It offers flexible evaluation code that users can easily adapt -according to their needs. It is build on a modern software stack using Python3 -and Met+ in a conda environment to support portability. Clear documentation, -working practices, automatic testing, and open access ensure developers can -easily use and contribute to this system. +It aligns parametrisation development, diagnostic development and evaluation +research, feeding back into RAL (Regional Atmosphere and Land) development +across the Met Office and UM partnership. + +Apart from verification capabilities it provides a centralised source of tools +to aid process-oriented evaluation for UM and LFRic models, supporting both +deterministic and ensembles. + +For model developers CSET offers well documented and peer reviewed evaluation +tools and flexible evaluation code that can adapt to users needs. + +For diagnostic developers it provides a legacy for diagnostics and observations. +It is build on a modern software stack using python 3 and METplus. Clear +documentation, working practices, automatic testing, and open access promote +contributions. Please read [the documentation](https://metoffice.github.io/CSET) to learn more about CSET, and how to use it. diff --git a/docs/source/background/why-cset.rst b/docs/source/background/why-cset.rst index 605e1586c..c38b8151f 100644 --- a/docs/source/background/why-cset.rst +++ b/docs/source/background/why-cset.rst @@ -18,17 +18,4 @@ for, and benefit the entire modelling community. Furthermore, any operators that the community finds especially useful will be contributed back to METplus_, so they can serve an even wider community. -It aims to align parametrisation, diagnostic development and evaluation research -linked to Met Office Research Atmosphere Land suites (RAL) across the Met Office -and UM partnership. Apart from verification capabilities it focusses on -providing and continuously developing a centralised source of tools to aid -process-oriented evaluation for UM and LFRic systems supporting deterministic -models and ensembles. It supports community development of well documented and -peer reviewed evaluation tools and provides a legacy for diagnostics and -observations. It offers flexible evaluation code that users can easily adapt -according to their needs. It is build on a modern software stack using Python3 -and Met+ in a conda environment to support portability. Clear documentation, -working practices, automatic testing, and open access ensure developers can -easily use and contribute to this system. - .. _METplus: https://dtcenter.org/community-code/metplus diff --git a/docs/source/index.rst b/docs/source/index.rst index 63fdcf029..8d6d1d235 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -11,14 +11,15 @@ CSET Documentation background/index contributing/index -:abbr:`CSET (Acronym meaning contested)` is a tool to aid in verifying and -evaluating :abbr:`ESM (Earth System Model)` configurations. It aims to replace -the :abbr:`RES (Regional Evaluation Suite)`, :abbr:`RMED (Regional Model -Evaluation & Development)` Toolbox and the collections of bespoke scripts -littering people's home directories. By centralising these in CSET the effort -spent on duplicate code can be reduced, and give a chance for code review to -catch any bugs. This will make evaluations more consistent, reproducible and -comparable. For more, see :doc:`/background/why-cset` +:abbr:`CSET (Convective and turbulence scale Evaluation and verification +Toolkit)` is a tool to aid in verifying and evaluating :abbr:`ESM (Earth System +Model)` configurations. It aims to replace the :abbr:`RES (Regional Evaluation +Suite)`, :abbr:`RMED (Regional Model Evaluation & Development)` Toolbox and the +collections of bespoke scripts littering people's home directories. By +centralising these in CSET the effort spent on duplicate code can be reduced, +and give a chance for code review to catch any bugs. This will make evaluations +more consistent, reproducible and comparable. For more, see +:doc:`/background/why-cset` Use the side bar to the left to access other pages of the documentation. From d66b8c7b9951e1a747b9150508c95739bd590954 Mon Sep 17 00:00:00 2001 From: James Frost Date: Tue, 17 Oct 2023 15:06:26 +0000 Subject: [PATCH 6/6] Grammar --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e822ecc89..ad6d2a82a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # CSET (Convective and turbulence scale Evaluation and verification Toolkit) CSET is a toolkit for verification, evaluation and investigation of convective- -and turbulence-scale numerical models for weather and climate applications +and turbulence-scale numerical models for weather and climate applications, cutting across time and space scales. It aligns parametrisation development, diagnostic development and evaluation