NCAS-CMS / NCAS-CMS/cf-plot

`ggap.nc` examples fail w/ downloaded data due to indexing

Open
#120 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs
Dominant language
Python
Stars
21
Forks
11
Avg merge
7h 11m
Merged PRs (30d)
1

Description

Since providing download access to the sample datasets used in the examples in #113, and setting the test suite to use those exactly for consistency, I noticed lots of new test failures. Upon investigation, it is only examples that use the ggap.nc dataset which are newly failing, with the cause being that the wrong field is being picked out from the read-in fieldlist - the index used is taking the wrong field now, for some reason (somehow in my local sample data, the fields got in a different order in the list I imagine).

This highlights the brittleness mentioned in #119, and by addressing that Issue, it will fix the failures and make the examples and tests more robust to boot.

Image comparison diff evidence

As examples of corresponding image comparison diff failures, showcasing that each output is generated and seems consistent, but shows the wrong (part of, or set of) data, see below.

Example 19b
Image
Example 19c
Image

Contributor guide

Open the contributing guide

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 with the examples that use the downloaded ggap.nc dataset and the image-comparison failures for Examples 19b and 19c. Read issue #119 for the related brittleness context, then run the affected examples and tests; done means they select the intended data fields and pass consistently with the downloaded samples.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data-visualization
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.