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

Update README.md #206

Merged
merged 6 commits into from
Oct 17, 2023
Merged
Show file tree
Hide file tree
Changes from all 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
29 changes: 21 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,24 @@
# 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
the CSET repository on GitHub.
# 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 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.
Expand Down
5 changes: 2 additions & 3 deletions docs/source/background/why-cset.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,7 @@ 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.

.. _METplus: https://dtcenter.org/community-code/metplus
17 changes: 9 additions & 8 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down