# \`benchcab\`: Python-based software for the evaluation of CABLE **URL:** \ **Category:** ACCESS-NRI Releases\ **Tags:** python, model-evaluation, release, land, cable, cable-watch\ **Created:** [20 June 2023 22:56 UTC](https://forum.access-hive.org.au/t/benchcab-python-based-software-for-the-evaluation-of-cable/873 "2023-06-20T22:56:47Z")\ **Posts on this page:** 11\ **Page:** 1
**Author:** ![clairecarouge](https://sea2.discourse-cdn.com/flex020/user_avatar/forum.access-hive.org.au/clairecarouge/32/380_2.png) [@clairecarouge](https://forum.access-hive.org.au/u/clairecarouge)\ **Post date:** [20 June 2023 22:56 UTC](https://forum.access-hive.org.au/t/benchcab-python-based-software-for-the-evaluation-of-cable/873/1 "2023-06-20T22:56:47Z")
This topic is to announce new releases of `benchcab`. `benchcab` is a Python-based software for the scientific evaluation of CABLE on NCI. To receive email notifications when a new release is announced, please [watch](https://www.youtube.com/watch?v=13sgFeSccm0) this topic. * * * πŸš€ **Release** : 2.0.0 This is our first fully public release of this software. Please do not hesitate to give us feedback on [this forum](https://forum.access-hive.org.au/t/benchcab-feedback-including-analysis-plots-ideas/878/10) or [GitHub](https://github.com/CABLE-LSM/benchcab/issues) so `benchcab` can become more useful to you. **Get started** Refer to [`benchcab`’s User guide](https://benchcab.readthedocs.io/en/v2.0.0/). **Features** : - βœ… run several CABLE versions at various flux tower sites with the same compilation\* and a [standard set of science configurations](https://benchcab.readthedocs.io/en/latest/user_guide/default_science_configurations/). - βœ… choice of sets of flux tower sites to allow different levels of testing - βœ… bitwise comparison of CABLE outputs - βœ… CABLE outputs from `benchcab` is compatible with experiments on [modelevaluation.org](http://modelevaluation.org) (workspace `benchcab-evaluation`) - βœ… compatible with CABLE v3 and v2 (limited testing of v2). - βœ… allow running tests of CABLE’s branches owned by others - βœ… [versioned documentation](https://benchcab.readthedocs.io/en/v2.0.0/), including how to use [modelevaluation.org](http://modelevaluation.org) with `benchcab` outputs. - βœ… [example work directory](https://github.com/CABLE-LSM/bench_example) - βœ… allow running a customised set of science configurations on one branch (e.g. test new feature) or all branches. \*: the compilation may differ between the branches if the CABLE source codes are not both based on CABLE v3. **Limitations** : - πŸ›‘ no support for gridded (spatial) simulations - πŸ›‘ limited standard set of science configurations. Feedback on the choice of configurations is welcomed. Please see [this forum topic](https://forum.access-hive.org.au/t/science-configurations-to-use-for-cable-evaluation/662/3) to leave some feedback. - πŸ›‘ no testing with any spin-up. But starting the simulations from a given restart file is possible and easy to do. - πŸ›‘ no testing with CASA - πŸ›‘ analysis plots will be updated to allow easier comparison between science configurations and include more variables. - πŸ›‘ limited to use on NCI’s supercomputer ⚠ Since `benchcab` is still in active development, future versions might not be backward-compatible ---
**Author:** ![clairecarouge](https://sea2.discourse-cdn.com/flex020/user_avatar/forum.access-hive.org.au/clairecarouge/32/380_2.png) [@clairecarouge](https://forum.access-hive.org.au/u/clairecarouge)\ **Post date:** [20 June 2023 23:00 UTC](https://forum.access-hive.org.au/t/benchcab-python-based-software-for-the-evaluation-of-cable/873/2 "2023-06-20T23:00:22Z")
---
**Author:** ![clairecarouge](https://sea2.discourse-cdn.com/flex020/user_avatar/forum.access-hive.org.au/clairecarouge/32/380_2.png) [@clairecarouge](https://forum.access-hive.org.au/u/clairecarouge)\ **Post date:** [23 June 2023 01:44 UTC](https://forum.access-hive.org.au/t/benchcab-python-based-software-for-the-evaluation-of-cable/873/3 "2023-06-23T01:44:13Z")
---
**Author:** ![clairecarouge](https://sea2.discourse-cdn.com/flex020/user_avatar/forum.access-hive.org.au/clairecarouge/32/380_2.png) [@clairecarouge](https://forum.access-hive.org.au/u/clairecarouge)\ **Post date:** [15 November 2023 02:57 UTC](https://forum.access-hive.org.au/t/benchcab-python-based-software-for-the-evaluation-of-cable/873/4 "2023-11-15T02:57:42Z")
2 posts were merged into an existing topic: [Analysis plots for benchcab](https://forum.access-hive.org.au/t/analysis-plots-for-benchcab/878/9) ---
**Author:** ![clairecarouge](https://sea2.discourse-cdn.com/flex020/user_avatar/forum.access-hive.org.au/clairecarouge/32/380_2.png) [@clairecarouge](https://forum.access-hive.org.au/u/clairecarouge)\ **Post date:** [15 November 2023 02:58 UTC](https://forum.access-hive.org.au/t/benchcab-python-based-software-for-the-evaluation-of-cable/873/5 "2023-11-15T02:58:54Z")
---
**Author:** ![SeanBryan51](https://sea2.discourse-cdn.com/flex020/user_avatar/forum.access-hive.org.au/seanbryan51/32/276_2.png) [@SeanBryan51](https://forum.access-hive.org.au/u/SeanBryan51)\ **Post date:** [29 November 2023 00:04 UTC](https://forum.access-hive.org.au/t/benchcab-python-based-software-for-the-evaluation-of-cable/873/6 "2023-11-29T00:04:50Z")
πŸš€ **Release** : 3.0.0 Benchcab v3.0.0 has now been released. Please do not hesitate to give us feedback on [this forum](https://forum.access-hive.org.au/t/benchcab-feedback-including-analysis-plots-ideas/878/10) or [GitHub](https://github.com/CABLE-LSM/benchcab/issues) so `benchcab` can become more useful to you. **Get started** Refer to [`benchcab`’s User guide](https://benchcab.readthedocs.io/en/v3.0.0/). **Features** : - βœ… configure PBS job parameters at run time for fluxsite tests - βœ… delete namelist parameters for a specific model version with [patch remove](https://benchcab.readthedocs.io/en/v3.0.0/user_guide/config_options/#patch_remove) - βœ… added support for testing CABLE repositories on GitHub - βœ… general improvements and bug fixes See [the release notes](https://github.com/CABLE-LSM/benchcab/releases/tag/v3.0.0) for more details. ⚠ Configurations used with `benchcab` v2.0.0 need to be updated to be compatible with v3.0.0. The `realisations` option in the `config.yaml` file has a new format, see [example](https://github.com/CABLE-LSM/bench_example/blob/main/config.yaml). ---
**Author:** ![abhaasgoyal](https://sea2.discourse-cdn.com/flex020/user_avatar/forum.access-hive.org.au/abhaasgoyal/32/1578_2.png) [@abhaasgoyal](https://forum.access-hive.org.au/u/abhaasgoyal)\ **Post date:** [7 March 2024 06:05 UTC](https://forum.access-hive.org.au/t/benchcab-python-based-software-for-the-evaluation-of-cable/873/7 "2024-03-07T06:05:09Z")
πŸš€ **Release** : 4.0.0 Benchcab v4.0.0 has now been released. Please do not hesitate to give us feedback on [this forum](https://forum.access-hive.org.au/t/benchcab-python-based-software-for-the-evaluation-of-cable/873) or [GitHub](https://github.com/CABLE-LSM/benchcab/issues) so `benchcab` can become more useful to you. **Get started** Refer to [`benchcab`’s User guide](https://benchcab.readthedocs.io/en/v4.0.0/). **Features** : - βœ… Config changes - move `experiment` key under `fluxsite`, make `project` key optional. - βœ… Config addition - support `local` realisation paths for CABLE checkouts. - βœ… Add Endpoint for spatial workflows using `payu` (as of now, version `>=1.0.30` is supported). - βœ… Using logging module for controlling and formatting standard output. - βœ… Deprecate `serial_cable` and `parallel_cable` scripts in [older versions](https://github.com/CABLE-LSM/CABLE/pull/193) of CABLE. - βœ… Add new CLI argument - `clean` for resetting `benchcab` workflow stages. - βœ… general improvements in documentation, testing, versioning and CI/CD. Minor bug fixes. See [the release notes](https://github.com/CABLE-LSM/benchcab/releases/tag/v4.0.0) for more details. ⚠ Configurations used with `benchcab` v3.0.0 may need to be updated to be compatible with v4.0.0. For example, moving `experiment` key under `fluxsite`. ---
**Author:** ![SeanBryan51](https://sea2.discourse-cdn.com/flex020/user_avatar/forum.access-hive.org.au/seanbryan51/32/276_2.png) [@SeanBryan51](https://forum.access-hive.org.au/u/SeanBryan51)\ **Post date:** [22 August 2024 01:01 UTC](https://forum.access-hive.org.au/t/benchcab-python-based-software-for-the-evaluation-of-cable/873/8 "2024-08-22T01:01:50Z")
πŸš€ **Release** : 4.1.0 Benchcab v4.1.0 has now been released. Please do not hesitate to give us feedback on [this forum](https://forum.access-hive.org.au/t/benchcab-feedback-including-analysis-plots-ideas/878/10) or [GitHub](https://github.com/CABLE-LSM/benchcab/issues) so `benchcab` can become more useful to you. **Get started** Refer to [`benchcab`’s User guide](https://benchcab.readthedocs.io/en/v3.0.0/). **Features** : - βœ… code coverage analysis with the [codecov option](https://benchcab.readthedocs.io/en/stable/user_guide/config_options/#codecov) - βœ… general improvements and bug fixes See [releases](https://github.com/CABLE-LSM/benchcab/releases) for more details. ---
**Author:** ![SeanBryan51](https://sea2.discourse-cdn.com/flex020/user_avatar/forum.access-hive.org.au/seanbryan51/32/276_2.png) [@SeanBryan51](https://forum.access-hive.org.au/u/SeanBryan51)\ **Post date:** [18 November 2024 03:54 UTC](https://forum.access-hive.org.au/t/benchcab-python-based-software-for-the-evaluation-of-cable/873/9 "2024-11-18T03:54:26Z")
πŸš€ **Release** : 4.2.0 Benchcab v4.2.0 has now been released. Please do not hesitate to give us feedback on [this forum](https://forum.access-hive.org.au/t/benchcab-feedback-including-analysis-plots-ideas/878/10) or [GitHub](https://github.com/CABLE-LSM/benchcab/issues) so `benchcab` can become more useful to you. **Get started** Refer to [`benchcab`’s User guide](https://benchcab.readthedocs.io/en/v3.0.0/). **Features** : - βœ… automated file upload via meorg client (see [meorg\_model\_output\_id](https://benchcab.readthedocs.io/en/v4.2.0/user_guide/config_options/#meorg_model_output_id) option for details) - βœ… CABLE build system updates - βœ… updated documentation and general improvements See [releases](https://github.com/CABLE-LSM/benchcab/releases) for more details. ---
**Author:** ![SeanBryan51](https://sea2.discourse-cdn.com/flex020/user_avatar/forum.access-hive.org.au/seanbryan51/32/276_2.png) [@SeanBryan51](https://forum.access-hive.org.au/u/SeanBryan51)\ **Post date:** [22 September 2025 02:17 UTC](https://forum.access-hive.org.au/t/benchcab-python-based-software-for-the-evaluation-of-cable/873/10 "2025-09-22T02:17:41Z")
πŸš€ **Release** : 4.2.4 Benchcab v4.2.4 has now been released. This version is available to use in the [`xp65` NCI project](https://my.nci.org.au/mancini/project/xp65). Please do not hesitate to give us feedback on [this forum](https://forum.access-hive.org.au/t/benchcab-feedback-including-analysis-plots-ideas/878/10) or on [GitHub](https://github.com/CABLE-LSM/benchcab/issues) so `benchcab` can become more useful to you. **Get started** Refer to [`benchcab`’s User guide](https://benchcab.readthedocs.io/en/v4.2.4/user_guide/). **Features** : - βœ… migration from hh5 to xp65 conda environments - βœ… updated documentation and general improvements See [releases](https://github.com/CABLE-LSM/benchcab/releases) for more details. ---
**Author:** ![abhaasgoyal](https://sea2.discourse-cdn.com/flex020/user_avatar/forum.access-hive.org.au/abhaasgoyal/32/1578_2.png) [@abhaasgoyal](https://forum.access-hive.org.au/u/abhaasgoyal)\ **Post date:** [19 October 2025 22:55 UTC](https://forum.access-hive.org.au/t/benchcab-python-based-software-for-the-evaluation-of-cable/873/11 "2025-10-19T22:55:18Z")
πŸš€ **Release** : 4.3.0 Benchcab v4.3.0 has now been released. Please do not hesitate to give us feedback on [this forum](https://forum.access-hive.org.au/t/benchcab-feedback-including-analysis-plots-ideas/878/10) or on [GitHub](https://github.com/CABLE-LSM/benchcab/issues) so `benchcab` can become more useful to you. **Get started** Refer to [`benchcab`’s User guide](https://benchcab.readthedocs.io/en/v4.2.4/user_guide/). **Features** : - βœ… New features for running workflows in [modelevaluation.org](http://modelevaluation.org) via API - Support for creating model output - Automate experiment and benchmark addition based on `config.yaml` - βœ… General improvements in documentation, testing (including other packages like `meorg_client`) See [releases](https://github.com/CABLE-LSM/benchcab/releases) for more details.