Update documentation to reflect larger remit of CSET #1824
Conversation
…tions and reflecting seamless approach for time and space scales i.e. weather and (regional) climate in documentation
Sylviabohnenstengel
added
the
documentation
|
|
ukmo-huw-lewis
left a comment
ukmo-huw-lewis
left a comment
There was a problem hiding this comment.
In general, think these are looking like good changes.
Review has got me thinking further on some aspects, maybe in particular greater use of bullets to aid readability, and some suggested/requested changes to phrasing and emphasis that I hope worth considering before we make these changes.
Note also comment on value of consistency with top-level GitHub pages.
Finally, given the shift to Community Seamless Evaluation Toolkit, I have had in view the value of setting out what these words mean - I think each is powerful and usefully explain some of the 'philosophy' and what to expect from CSET. Can we add this narrative somewhere? A starter for 10 offered below (have a go at making these shorter/impactful etc):
Community: Software developed for and by a wide network of model development and evaluation scientists, enabling common approaches to distributed evaluation activities.
Seamless: Supporting assessment, evaluation, verification and understanding of physical and machine learning models across time and space scales, and from regional to global application.
Evaluation: Providing a process-oriented focus to model assessment, supporting depth of comparison between different model configurations and assessment relative to a range of observations.
Toolkit: A flexible software including code, recipes and workflow to manage a range of user requirements, underpinned by modern software development practices.
docs/source/index.rst
Outdated
|
|
||
| CSET provides a centralised and peer-reviewed source of tools to aid | ||
| process-oriented evaluation for UM and LFRic models, supporting both | ||
| process-oriented evaluation for UM, LFRic physical and ML models, supporting both |
There was a problem hiding this comment.
Suggest to make this more model agnostic here:
....to aid process-oriented evaluation for physical and machine learning models, supporting both...
docs/source/index.rst
Outdated
| CSET is expanding it's support for verification and evaluation of machine learned models | ||
| and utilises observations from a range of sources to aid in the evaluation process. | ||
| It will utilise the Model Evaluation Tools (MET) software to provide a range of | ||
| verification metrics aligned with operational verification best practices. |
There was a problem hiding this comment.
Propose....
CSET is designed to be continuously evolving and improving, driven by community inputs. Support for verification and evaluation of a range of machine learning models is expected to grow, alongside use of observations from an increasing range of sources to support evaluation. It will utilise the Model Evaluation Tools (MET) software to provide a range of verification metrics aligned with operational verification best practices. Where relevant, CSET will provide interfaces to utilise other evaluation packages to support particular evaluation requirements.
There was a problem hiding this comment.
included
Sylviabohnenstengel
left a comment
Sylviabohnenstengel
left a comment
There was a problem hiding this comment.
worked though your suggestions and included them into the documents. Still working on some changes
docs/source/index.rst
Outdated
| CSET is expanding it's support for verification and evaluation of machine learned models | ||
| and utilises observations from a range of sources to aid in the evaluation process. | ||
| It will utilise the Model Evaluation Tools (MET) software to provide a range of | ||
| verification metrics aligned with operational verification best practices. |
There was a problem hiding this comment.
included
|
Still working on some changes so please don't merge. |
|
GitHub copilot used to help with formatting |
|
@Fraetor wondering if the Why CSET? section under background is becoming obsolete. |
|
The "Why CSET" page is intended to provide detailed justification for CSET without overwhelming people on the documentation landing page. So I'm not sure its becoming obsolete, but it may need updating to reflect CSET's current position. |
jfrost-mo
changed the title
Sylviabohnenstengel
left a comment
Sylviabohnenstengel
left a comment
There was a problem hiding this comment.
happy with changes
jfrost-mo
left a comment
jfrost-mo
left a comment
There was a problem hiding this comment.
I think the documentation landing page (index.rst) is probably getting a little bit overwhelmed with detail. My suggestion would be to cut it down, so it has the same content as the README, and move the additional detail to the why-cset page. Then have a link from the index to the why-cset page.
This way, people who are already convinced are not overwhelmed with excessive detail or background, while those that desire it can find out more about the rational.
| CSET is a toolkit for evaluation, verification and investigation of convective- | ||
| and turbulence-scale numerical models for weather and climate applications, | ||
| cutting across time and space scales. | ||
| CSET, the Community Seamless Evaluation Toolkit, is an open-source toolkit for evaluating weather and climate models, including physical numerical and machine learning models, as well as observations. It focuses on high-resolution atmospheric processes, from convective to turbulence scales, across regional to global domains. |
There was a problem hiding this comment.
| CSET, the Community Seamless Evaluation Toolkit, is an open-source toolkit for evaluating weather and climate models, including physical numerical and machine learning models, as well as observations. It focuses on high-resolution atmospheric processes, from convective to turbulence scales, across regional to global domains. | |
| CSET, the Community Seamless Evaluation Toolkit, is an open source toolkit for evaluating weather and climate models, including physical numerical, machine learning models, and observations. It focuses on high-resolution atmospheric processes, from convective to turbulence scales, across regional or global domains. |
| CSET is built with portability in mind and can be run on: | ||
| - Local desktops. | ||
| - HPC systems. | ||
| - Cloud servers. |
There was a problem hiding this comment.
| CSET is built with portability in mind and can be run on: | |
| - Local desktops. | |
| - HPC systems. | |
| - Cloud servers. | |
| CSET is built with portability in mind and can be [easily installed](https://metoffice.github.io/CSET/getting-started/installation.html). |
Rather than enumerating the kinds of systems CSET can be installed on, we should just emphasise that it is easy to install.
| - A legacy for model and observation based diagnostics through continued maintenance and improved discoverability. | ||
|
|
||
| CSET is built using a modern software stack, underpinned by | ||
| - python3, |
There was a problem hiding this comment.
| - python3, | |
| - python 3, |
There was a problem hiding this comment.
I'm not sure we need to specify that we use python 3. The GitHub UI already shows that CSET is mostly python, and python 2 is very much dead by now.
|
|
||
| CSET is built using a modern software stack, underpinned by | ||
| - python3, | ||
| - iris and |
There was a problem hiding this comment.
| - iris and | |
| - iris |
|
I've made some changes in #1831. If you are happy with them you should be able to merge that PR into this one. |
fixes #1823
Contribution checklist
Aim to have all relevant checks ticked off before merging. See the developer's guide for more detail.