MetOffice / MetOffice/CSET

Include additional information in diagnostic description

Open
#1,788 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement super
Dominant language
Python
Stars
33
Forks
19
Avg merge
1d 22h
Merged PRs (30d)
30

Description

### What problem does your feature request solve?

The description on the diagnostic page only shows what is written in the recipe. We should include additional information there.

### Describe the solution you'd like

We should include lots of different types of information:

* https://github.com/MetOffice/CSET/issues/583
* https://github.com/MetOffice/CSET/issues/558 Actually show in HTML output, rather than just on plot.
* https://github.com/MetOffice/CSET/issues/830
* https://github.com/MetOffice/CSET/issues/811
* https://github.com/MetOffice/CSET/issues/1713 Add all of the facets used here.
* https://github.com/MetOffice/CSET/issues/1452 Information mentioned in this issue.
* Path to output data.
* Showing the recipe file in the output, possibly including the documentation for each operator.
* Showing the recipe's log in the output. I have an unpushed branch for this.

### Describe alternatives you've considered

Currently a lot of this information is logged, but not displayed anywhere.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the linked issues 583, 558, 830, 811, 1713, and 1452 to determine which diagnostic information belongs in the output. Done should be defined as a scoped set of recipe, facet, log, output-path, or operator documentation details appearing on the diagnostic page or in HTML output.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data-visualization
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.