search

MetOffice / CSET

Toolkit for evaluation and investigation of numerical models for weather and climate applications.
https://metoffice.github.io/CSET/
Apache License 2.0
8 stars 1 forks source link

Document style file syntax #591

Open jfrost-mo opened 1 month ago

jfrost-mo commented 1 month ago

What problem does your feature request solve?

The style files added in #570 are largely undocumented, which makes it hard to write new ones.

Describe the solution you'd like

A page should be added to the Technical Reference section of the documentation, similar to the existing Recipe Format page. This should have a reference to the format of the style file (JSON), the meaning of the various keys, and some examples showing how it can be structured.

Describe alternatives you've considered

We don't document it, and no one knows how to write CSET style files except @cjohnson-pi.

Sylviabohnenstengel commented 1 month ago

I think that the rose meta information needs to be a bit clearer as I was unsure how directory and filename should be entered when configuring it based on the help text alone. I have made a PR: https://github.com/MetOffice/CSET/pull/632 to address this and also linked to the json file in the extra meta data.