Changelog¶

Unreleased¶

@jfrost-mo added a Generative AI policy in PR #624
@jfrost-mo linked to the CSET discussion forum in PR #625
@jwarner8 use common operator to identify x/y coord names in regrid operator PR #626
@jwarner8 added generic cube util for common functions so all operators can use to reduce repetition in PR #620
@jfrost-mo added a code of conduct in PR #618
@jfrost-mo fixed some rose edit metadata so the subarea selectors show up when enabled in PR #612
@jfrost-mo removed some old recipes that are now redundant in PR #512
@jfrost-mo added a git cheat sheet to the documentation in PR #598
@jfrost-mo added a warning when input files don’t exist in PR #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
@dasha-shchep added generate_area_constraint operator and added to LFRic recipes in PR #522. This was their first contribution 🎉
@jfrost-mo dropped python 3.9 support in PR #448 The minimum required python is now 3.10.
@jfrost-mo fixed some outdated documentation examples in PR #546
@jfrost-mo added setuptools as an explicit dependency of the workflow in PR #543
@cjohnson-pi added support for custom plotting styles in PR #570. This avoids many issues of side-by-side plots having different scales, or extreme values causing plots to saturate.
@Sylviabohnenstengel documentation: removed necessity to add new recipe to flow.cylc.
@Ashfinn fixed a typo in the documentation in PR #573. This was their first contribution 🎉
@jfrost-mo fixed how arguments from the CSET_ADDOPTS environment variable are parsed in PR #569. This fixes issues with passing lists into recipes.
@jfrost-mo added a dead link checker to the documentation in PR #556
@Sylviabohnenstengel documented the common error of operating on a CubeList instead of a Cube in PR #541
@Sylviabohnenstengel documented how to update your conda environment in PR #519
@Sylviabohnenstengel documented the common error of no cubes being loaded in PR #513
@Sylviabohnenstengel and @jfrost-mo redid the rose-meta sort orders so that workflow configuration makes more sense in PR #504
@jfrost-mo updated the example rose-suite.conf to reflect what a modern version should look like in PR #508

24.4.1 (2024-04-19)¶

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.

@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

24.2.1 (2024-03-04)¶

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

Graceful error when graphing without xdg-open by @jfrost-mo in PR #394
Docs update by @jfrost-mo in PR #392
Update workflow conda lockfiles automatically by @jfrost-mo in PR #410
Handle LD_LIBRARY_PATH being unset by @jfrost-mo in PR #404

24.2.0 (2024-02-13)¶

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.

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

0.5.0 (2023-11-24)¶

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

Bump version to 0.5.0 by @jfrost-mo in PR #278
Improve contour plot by @jfrost-mo in PR #282

0.4.0 (2023-11-23)¶

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.

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

0.3.0 (2023-08-02)¶

This release contains some major changes to the user experience. This includes many of the CLI commands changing names, and the CSET Documentation being completely restructured. Hopefully this should be the last major reshuffle of the user experience, as we are getting closers to being feature complete for our MVP.

Other highlights include the addition of the cset graph command for visualising recipes, and the cset cookbook command for dumping the built in recipes to disk.

Operator runner improvements by @jfrost-mo in PR #128
Add codespell pre-commit hook by @jfrost-mo in PR #135
Add graph command to visualise recipe files by @jfrost-mo in PR #136
Pin version of tox used in environment by @jfrost-mo in PR #142
Increase version number by @jfrost-mo in PR #124
Update description of CSET by @jfrost-mo in PR #141
Refactoring by @jfrost-mo in PR #144
Rename run command to bake by @jfrost-mo in PR #143
Add command to create recipes on disk by @jfrost-mo in PR #140
Documentation restructure by @jfrost-mo in PR #151
Add version command by @jfrost-mo in PR #156
General cleanup by @jfrost-mo in PR #158
Remove Python 3.8 support by @jfrost-mo in PR #173
Fix install instructions in docs by @jfrost-mo in PR #176
Allow PR checks to be run manually by @jfrost-mo in PR #179
Ensemble ingestion with read operator by @jfrost-mo in PR #157
Update working practices link to point to contributing docs by @jfrost-mo in PR #175

0.2.0 (2023-06-16)¶

Lots of good work in the release towards making the recipe format more usable.

Update installation instructions to use conda and add missing operators to documentation by @jfrost-mo in PR #94
Update index.rst by @Sylviabohnenstengel in PR #95
Improve installation instructions by @jfrost-mo in PR #97
Use speedy libmamba when resolving conda environments by @jfrost-mo in PR #105
Add documentation on rational by @jfrost-mo in PR #102
Relax version requirement for sphinx by @jfrost-mo in PR #108
Run PR checks on push to main by @jfrost-mo in PR #109
Move to YAML recipe format by @jfrost-mo in PR #119
Lock pre-commit config to specific SHA by @jfrost-mo in PR #118
Use recipes from environment variable by @jfrost-mo in PR #122

0.1.0 (2023-04-24)¶

The first release of CSET! 🎉 This release contains basic operators to do reading, writing, filtering, and plotting of data. It is however still quite limited in each of them, and still doesn’t promise much in the way of API stability, with things undoubtedly going to undergo significant change in the near future.

This release also serves as a basis for packaging CSET out into the wider world; packages will be released on PyPI, and conda-forge.

Re-enable testing on python 3.11 by @jfrost-mo in PR #61
Operator runner improvements by @jfrost-mo in PR #56
Move METplus tasks out of command line repository by @jfrost-mo in PR #76
Remove extra punctuation from conda lock CI commit message by @jfrost-mo in PR #78
Measure test coverage by @jfrost-mo in PR #68
Improve test coverage by @jfrost-mo in PR #81
Fix link to Git tutorial by @jfrost-mo in PR #83
Fix description of a git tag by @jfrost-mo in PR #84
Add basic plotting capabilities by @jfrost-mo in PR #85
Make PR coverage reports edit last comment by @jfrost-mo in PR #92
Package on PyPI by @jfrost-mo in PR #90