MetOffice / MetOffice/CMEW

Add limited options for some dataset options and improve explanations

Open Beginner friendly
#564 0 comments 0 reactions 0 assignees View on GitHub
configure investigation needs refinement rose
Dominant language
Python
Stars
5
Forks
3
Avg merge
5d 6h
Merged PRs (30d)
8

Description

e.g.:

`model_id` should be a controlled list (CDDS uses this). We can then remove "For example". Use the help to tell users why we need this.

Investigate:
- Where are the different options for datasets used?
- Whether they come from a list of known options

Time box:
- 0.5 day

For example:
[namelist:model_runs(reference)]
calendar="360_day" - CDDS
experiment_id="historical" - ESMValTool
label_for_plots="HadGEM3-GC3.1 N96ORCA1" [Possibility to add info on model horizontal and vertical resolution info] - ESMValTool & AutoAssess
model_id="HadGEM3-GC31-LL" - CDDS & ESMValTool
suite_id="u-bv526" - CDDS & ESMValTool & AutoAssess (& CMEW behaviour)
variant_label="r5i1p1f3" - ESMValTool

Consider ordering this list based on usage.

Possible solutions:
- Add the acceptable entries in to the Rose metadata.
- If there is a central list of run metadata, use the URL

Contributor guide

Open the contributing guide

Research direction

Start by tracing where dataset run metadata options such as model_id, calendar, experiment_id, suite_id, and variant_label are defined and consumed. Check whether Rose metadata or a central run-metadata list already provides the accepted values. Done means applying limited options where appropriate, improving the help explanations, and removing “For example” when the controlled list makes it unnecessary.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
2/5
Estimated time
Half a day
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.