Cset

This release contains a quite a number of small improvements, increasing the reliability of CSET significantly, and paving the way for further improvements to come.

* jfrost-mo replaced how the encoding of subprocess output is determined in [PR 604](https://github.com/MetOffice/CSET/pull/604). This adds support for python before 3.11, and more accurately reflects the encoding.
* jwarner8 add intelligent determination of whether to plot country lines in [PR 655](https://github.com/MetOffice/CSET/pull/655)
* daflack fixed inflow properties recipe in [PR 662](https://github.com/MetOffice/CSET/pull/662)
* daflack added science review guidance to the documentation in [PR 649](https://github.com/MetOffice/CSET/pull/649)
* jfrost-mo ensured cartopy data files are included in the GitHub Actions cache in [PR 647](https://github.com/MetOffice/CSET/pull/647)
* jfrost-mo grouped the package install logs in GitHub Actions in [PR 645](https://github.com/MetOffice/CSET/pull/645)
* daflack added an inflow layer properties diagnostic in [PR 353](https://github.com/MetOffice/CSET/pull/353)
* jfrost-mo fixed LFRic cube metadata on load in [PR 627](https://github.com/MetOffice/CSET/pull/627). This means that loading LFRic data no longer requires special steps in the recipe.
* jfrost-mo made the install_restricted_files.sh script non-interactive in [PR 606](https://github.com/MetOffice/CSET/pull/606). This should make it less confusing to use.
* Sylviabohnenstengel added information to rose-meta for colorbar selection and provided path to example JSON file in [PR 632](https://github.com/MetOffice/CSET/pull/632)
* jfrost-mo added a Generative AI policy in [PR 624](https://github.com/MetOffice/CSET/pull/624)
* jfrost-mo linked to the [CSET discussion forum](https://github.com/MetOffice/simulation-systems/discussions/categories/cset-toolkit) in [PR #625](https://github.com/MetOffice/CSET/pull/625)
* jwarner8 use common operator to identify x/y coord names in regrid operator [PR 626](https://github.com/MetOffice/CSET/pull/626)
* jwarner8 added generic cube util for common functions so all operators can use to reduce repetition in [PR 620](https://github.com/MetOffice/CSET/pull/620)
* JorgeBornemann added METPlus GridStat functionality (NIWA) in [PR 629](https://github.com/MetOffice/CSET/pull/629)
* jfrost-mo added a code of conduct in [PR 618](https://github.com/MetOffice/CSET/pull/618)
* jfrost-mo fixed some rose edit metadata so the subarea selectors show up when enabled in [PR 612](https://github.com/MetOffice/CSET/pull/612)
* jfrost-mo removed some old recipes that are now redundant in [PR 512](https://github.com/MetOffice/CSET/pull/512)
* jfrost-mo added a git cheat sheet to the documentation in [PR 598](https://github.com/MetOffice/CSET/pull/598)
* jfrost-mo added a warning when input files don’t exist in [PR 518](https://github.com/MetOffice/CSET/pull/518). This makes it easier to see if configuration mistakes were made.
* jfrost-mo improved the documentation for adding a new diagnostic in [PR 603](https://github.com/MetOffice/CSET/pull/603)
* dasha-shchep added generate_area_constraint operator and added to LFRic recipes in [PR 522](https://github.com/MetOffice/CSET/pull/522). This was their first contribution 🎉
* Sylviabohnenstengel added a vertical line plotting operator that plots vertical profiles using an optional series coordinate and an optional sequence coordinate in [PR 567](https://github.com/MetOffice/CSET/pull/567). The series coordinate is currently tested for pressure and the sequence coordinate allows displaying vertical profiles over time using the time slider functionality. Furthermore added a recipe to plot vertical profiles and test functions for the vertical plot operator.
* jfrost-mo dropped python 3.9 support in [PR 448](https://github.com/MetOffice/CSET/pull/448) The minimum required python is now 3.10.
* jfrost-mo fixed some outdated documentation examples in [PR 546](https://github.com/MetOffice/CSET/pull/546)
* jfrost-mo added setuptools as an explicit dependency of the workflow in [PR 543](https://github.com/MetOffice/CSET/pull/543)
* cjohnson-pi added support for custom plotting styles in [PR 570](https://github.com/MetOffice/CSET/pull/570). This avoids many issues of side-by-side plots having different scales, or extreme values causing plots to saturate. This was their first contribution 🎉
* Sylviabohnenstengel documentation: removed necessity to add new recipe to flow.cylc.
* Ashfinn fixed a typo in the documentation in [PR 573](https://github.com/MetOffice/CSET/pull/573). This was their first contribution 🎉
* jfrost-mo fixed how arguments from the CSET_ADDOPTS environment variable are parsed in [PR 569](https://github.com/MetOffice/CSET/pull/569). This fixes issues with passing lists into recipes.
* jfrost-mo added a dead link checker to the documentation in [PR 556](https://github.com/MetOffice/CSET/pull/556)
* Sylviabohnenstengel documented the common error of operating on a CubeList instead of a Cube in [PR 541](https://github.com/MetOffice/CSET/pull/541)
* Sylviabohnenstengel documented how to update your conda environment in [PR 519](https://github.com/MetOffice/CSET/pull/519)
* Sylviabohnenstengel documented the common error of no cubes being loaded in [PR 513](https://github.com/MetOffice/CSET/pull/513)
* Sylviabohnenstengel and jfrost-mo redid the rose-meta sort orders so that workflow configuration makes more sense in [PR 504](https://github.com/MetOffice/CSET/pull/504)
* jfrost-mo updated the example rose-suite.conf to reflect what a modern version should look like in [PR 508](https://github.com/MetOffice/CSET/pull/508)

This release contains a large generalisation of the CSET workflow, allowing use of templating to use the same recipe for multiple variables. It also adds cycling to the workflow, so a long workflow can be efficiently processed in parallel.

v24.4.0 doesn't exist, I just slipped up on the version numbering when releasing...

What's Changed

jfrost-mo added GitHub Issue and Pull Request templates, and a detailed contribution checklist to the documentation in PR 465
jfrost-mo added a changelog in PR 468
jfrost-mo documented the category recipe key in PR 499
jfrost-mo renamed the steps and post-steps keys to parallel and collate in PR 484. This makes them more meaningful, but is a breaking change.
daflack added some generic arithmetic operators in PR 452
jfrost-mo made the log output of the read operator nicer in PR 461
jfrost-mo added links to share feedback to the output page in PR 442
jfrost-mo documented some common errors in PR 443
jfrost-mo documented the deprecation policy in PR 444
jfrost-mo fixed an iris deprecation warning for save_split_attrs in PR 459
jfrost-mo added LFRic specific recipes in PR 462. This allows CSET to read in structured LFRic data.
jfrost-mo fixed a memory leak when plotting in PR 482
jfrost-mo included the recipe title in the plot title, giving more context to the output. This was PR 462
Sylviabohnenstengel added the capability to loop over model levels in PR 441
Sylviabohnenstengel and jfrost-mo renamed and better linked up the Developer’s Guide in PR 434 and PR 435
jfrost-mo updated the documentation Actions workflow to make it simpler and faster in PR 449
jfrost-mo added a cycling to the cylc workflow so recipes can be run in parallel across multiple nodes. This was PR 395
jfrost-mo added looping inside an include file for generalisation in PR 387
jwarner8 added a basic regridding operator in PR 405
jfrost-mo made conda-lock update PRs use a GitHub App in PR 415
Sylviabohnenstengel retitled code and tooling setup page in PR 433
Sylviabohnenstengel updated git terminology in PR 436
jfrost-mo added sequential plot display with unified postage stamp plots in PR 379
JorgeBornemann fixed IFS in build conda in PR 447
jfrost-mo added a licence header to convection tests in PR 450

New Contributors

* JorgeBornemann made their first contribution in https://github.com/MetOffice/CSET/pull/447

**Full Changelog**: https://github.com/MetOffice/CSET/compare/v24.2.1...v24.4.1

A small bug fix release containing several fixes that ensure portability on Australia's NCI system.

What's Changed
* Graceful error when graphing without xdg-open by jfrost-mo in https://github.com/MetOffice/CSET/pull/394
* Docs update by jfrost-mo in https://github.com/MetOffice/CSET/pull/392
* Update workflow conda lockfiles automatically by jfrost-mo in https://github.com/MetOffice/CSET/pull/410
* Handle LD_LIBRARY_PATH being unset by jfrost-mo in https://github.com/MetOffice/CSET/pull/404


**Full Changelog**: https://github.com/MetOffice/CSET/compare/v24.2.0...v24.2.1

With this release we have switched to [CalVer](https://calver.org/) for our versioning scheme. This makes it easier to know if you are using an out-of-date version,and saves us from always being on version `0.X`. We are using the format `YY.MM.patch`, e.g.: `24.2.0`.

[PyPI](https://pypi.org/project/CSET/24.2.0/) | [conda-forge](https://anaconda.org/conda-forge/cset)

This release open sources the cylc workflow, allowing for much easier running of CSET over large datasets. It also includes support for parametrising recipes to allow a single recipe to work for many cases. Information on how to use both of these things can be found in [the documentation](https://metoffice.github.io/CSET/).

Finally, a bug where the recipes were not being packaged has also been fixed (https://github.com/MetOffice/CSET/commit/9c6f05d91a928d203ad4c7924a4b34a35c94e69c).

Happy pancake day! 🥞

What's Changed

Along with updating dependencies the following PRs are included in this release.

* Open source workflow by jfrost-mo in https://github.com/MetOffice/CSET/pull/247
* CAPE ratio diagnostic by daflack in https://github.com/MetOffice/CSET/pull/325
* CAPE ratio rose edit tweak by daflack in https://github.com/MetOffice/CSET/pull/332
* Minor bug fix to cape ratio documentation by daflack in https://github.com/MetOffice/CSET/pull/336
* Use cached conda environment for CI by jfrost-mo in https://github.com/MetOffice/CSET/pull/351
* Single cube read operator by jfrost-mo in https://github.com/MetOffice/CSET/pull/323
* Hash updated config ensuring unique branch by jfrost-mo in https://github.com/MetOffice/CSET/pull/350
* Add filter_multiple_cubes operator by jfrost-mo in https://github.com/MetOffice/CSET/pull/362
* Test exception for invalid output directory by jfrost-mo in https://github.com/MetOffice/CSET/pull/364
* Test no constraints given to filter_multiple_cubes by jfrost-mo in https://github.com/MetOffice/CSET/pull/363
* Update workflow-installation.rst by Sylviabohnenstengel in https://github.com/MetOffice/CSET/pull/365
* Recipe parametrisation by jfrost-mo in https://github.com/MetOffice/CSET/pull/337
* Fix crash when running recipe from env var by jfrost-mo in https://github.com/MetOffice/CSET/pull/384

**Full Changelog**: https://github.com/MetOffice/CSET/compare/v0.5.0...v0.6.0

Small update featuring some better looking plots (though still a work-in-progress, see 240) and a documentation fix.

What's Changed
* Bump version to 0.5.0 by jfrost-mo in https://github.com/MetOffice/CSET/pull/278
* Improve contour plot by jfrost-mo in https://github.com/MetOffice/CSET/pull/282


**Full Changelog**: https://github.com/MetOffice/CSET/compare/v0.4.0...v0.5.0

Containing many months of work, this release contains many usability improvements, new generic operators, and a big change to the output, where it is now generated as handily viewable HTML pages.

What's Changed
* Update version to 0.4.0 by jfrost-mo in https://github.com/MetOffice/CSET/pull/180
* Postage stamp plots by jfrost-mo in https://github.com/MetOffice/CSET/pull/160
* Add collapse operator with corresponding yaml file and changes by Sylviabohnenstengel in https://github.com/MetOffice/CSET/pull/168
* Make plot.contour_plot and write.write_cube_to_nc return a cube by jfrost-mo in https://github.com/MetOffice/CSET/pull/183
* Postage stamp plot fix by jfrost-mo in https://github.com/MetOffice/CSET/pull/181
* Document collapse operator by jfrost-mo in https://github.com/MetOffice/CSET/pull/185
* Refactor tests to use PyTest helpers by jfrost-mo in https://github.com/MetOffice/CSET/pull/177
* Document installing CSET into its own environment by jfrost-mo in https://github.com/MetOffice/CSET/pull/198
* Update README.md by Sylviabohnenstengel in https://github.com/MetOffice/CSET/pull/206
* Use hash of updated lock files in branch name by jfrost-mo in https://github.com/MetOffice/CSET/pull/201
* Add note on updating a cloned repository by jfrost-mo in https://github.com/MetOffice/CSET/pull/190
* Skip build-docs on push to main by jfrost-mo in https://github.com/MetOffice/CSET/pull/200
* Python 3.12 support by jfrost-mo in https://github.com/MetOffice/CSET/pull/202
* Update README.md by Sylviabohnenstengel in https://github.com/MetOffice/CSET/pull/225
* Update README.md by Sylviabohnenstengel in https://github.com/MetOffice/CSET/pull/226
* Update why-cset.rst by Sylviabohnenstengel in https://github.com/MetOffice/CSET/pull/227
* Fix globbing for lock file hashing by jfrost-mo in https://github.com/MetOffice/CSET/pull/229
* Update index.rst by Sylviabohnenstengel in https://github.com/MetOffice/CSET/pull/228
* Update index.rst by Sylviabohnenstengel in https://github.com/MetOffice/CSET/pull/230
* Use static branch name while updating lock files by jfrost-mo in https://github.com/MetOffice/CSET/pull/245
* Swap out flake8 for Ruff by jfrost-mo in https://github.com/MetOffice/CSET/pull/218
* Including aggregate operator. by Sylviabohnenstengel in https://github.com/MetOffice/CSET/pull/241
* Fix filter operator for filtering cube by daflack in https://github.com/MetOffice/CSET/pull/258
* Fix pre-commit mangling test data by jfrost-mo in https://github.com/MetOffice/CSET/pull/273
* Improve tutorials by jfrost-mo in https://github.com/MetOffice/CSET/pull/209
* Model level constraint operator by Sylviabohnenstengel in https://github.com/MetOffice/CSET/pull/272
* Plot generation improvements by jfrost-mo in https://github.com/MetOffice/CSET/pull/274

New Contributors
* daflack made their first contribution in https://github.com/MetOffice/CSET/pull/258

**Full Changelog**: https://github.com/MetOffice/CSET/compare/v0.3.0...v0.4.0