Skip to content

New docs multi-layer plotting example - #2434

Merged
ukmo-huw-lewis merged 4 commits into
mainfrom
2433-add-multi-variable-example-gallery-doc
Aug 28, 2026
Merged

New docs multi-layer plotting example#2434
ukmo-huw-lewis merged 4 commits into
mainfrom
2433-add-multi-variable-example-gallery-doc

Conversation

@ukmo-huw-lewis

Copy link
Copy Markdown
Contributor

Fixes #2433

Contribution checklist

Aim to have all relevant checks ticked off before merging. See the developer's guide for more detail.

  • Documentation has been updated to reflect change.
  • New code has tests, and affected old tests have been updated.
  • All tests and CI checks pass.
  • Ensured the pull request title is descriptive.
  • Attributed any Generative AI, such as GitHub Copilot, used in this PR.
  • Marked the PR as ready to review.

MS CoPilot used in initial development of gallery through #2242

@ukmo-huw-lewis ukmo-huw-lewis linked an issue Aug 26, 2026 that may be closed by this pull request
@github-actions

github-actions Bot commented Aug 26, 2026

Copy link
Copy Markdown
Contributor
Total coverage: 93% (HTML report)
Name                                                              Stmts   Miss Branch BrPart  Cover
---------------------------------------------------------------------------------------------------
src/CSET/__init__.py                                                105      0     14      0   100%
src/CSET/_common.py                                                 156      0     54      0   100%
src/CSET/cset_workflow/app/fetch_fcst/bin/fetch_data.py             117     28     26      0    78%
src/CSET/cset_workflow/app/fetch_nimrod/bin/fetch_nimrod.py          81      8     28     11    83%
src/CSET/cset_workflow/app/finish_website/bin/finish_website.py      79      2      8      2    95%
src/CSET/cset_workflow/app/parbake_recipes/bin/parbake.py            29      0      8      0   100%
src/CSET/cset_workflow/app/send_email/bin/send_email.py              25      0      4      0   100%
src/CSET/cset_workflow/lib/python/jinja_utils.py                     17      0      6      0   100%
src/CSET/extract_workflow.py                                        103      1     26      1    98%
src/CSET/graph.py                                                    44      0     14      0   100%
src/CSET/operators/__init__.py                                       89      0     26      0   100%
src/CSET/operators/_atmospheric_constants.py                          9      0      0      0   100%
src/CSET/operators/_colormaps.py                                    249      3     72      4    98%
src/CSET/operators/_stash_to_lfric.py                                 3      0      0      0   100%
src/CSET/operators/_utils.py                                        200      8     74      6    95%
src/CSET/operators/ageofair.py                                      142      7     64      5    94%
src/CSET/operators/aggregate.py                                      77      1     22      1    98%
src/CSET/operators/aviation.py                                       61      0     18      0   100%
src/CSET/operators/collapse.py                                      155      8     72      3    93%
src/CSET/operators/constraints.py                                   113      7     50      3    93%
src/CSET/operators/convection.py                                     38      4     10      2    88%
src/CSET/operators/ensembles.py                                      27      0     14      0   100%
src/CSET/operators/feature.py                                        44      0     10      0   100%
src/CSET/operators/filters.py                                        67      2     30      0    98%
src/CSET/operators/fluxes.py                                         41      0     10      0   100%
src/CSET/operators/humidity.py                                      135      0     52      0   100%
src/CSET/operators/imageprocessing.py                                57      0     16      0   100%
src/CSET/operators/mesoscale.py                                      18      0      2      0   100%
src/CSET/operators/misc.py                                          172      1     72      3    98%
src/CSET/operators/plot.py                                         1122    158    412     71    82%
src/CSET/operators/power_spectrum.py                                 98      3     30      3    95%
src/CSET/operators/precipitation.py                                 204      2     92      2    99%
src/CSET/operators/pressure.py                                       41      0     12      0   100%
src/CSET/operators/read.py                                          442     22    190     17    94%
src/CSET/operators/regrid.py                                        147      1     70      3    98%
src/CSET/operators/scoreswrappers.py                                217     22     66      5    88%
src/CSET/operators/temperature.py                                   121      0     32      0   100%
src/CSET/operators/transect.py                                       63      0     24      0   100%
src/CSET/operators/wind.py                                           46      3     10      2    91%
src/CSET/operators/write.py                                          15      0      6      0   100%
src/CSET/recipes/__init__.py                                        104      0     28      0   100%
src/CSET/sample_data/__init__.py                                      0      0      0      0   100%
---------------------------------------------------------------------------------------------------
TOTAL                                                              5073    291   1774    144    93%

@ukmo-huw-lewis

Copy link
Copy Markdown
Contributor Author

Multi-layer plot example builds on global spatial plot example previously reviewed under #2405.

Changes here

  • introduce new multi-variable plot gallery doc page plot_spatial_multi.py

Example output in built html accessible in: plot_spatial_multi.html

Note advice welcome on current mismatch between reference in places to "multi" plotting (recipe, name of gallery file) and "overlay" (in page title). For now, deliberately mixing/matching as may mean different things to different people, but not sure if this more complicated.

Marking as ready for review.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Huw, generally all looks good. I am encouraging tidying-up of references to overlay so that all refer to multi-layer. I could be swayed by a counter argument for overlay but multi-layer seems to better cover two or three layer options to me.

Comment thread docs/source/reference/gallery/examples/spatial/plot_spatial_multi.py Outdated
Comment thread docs/source/reference/gallery/examples/spatial/plot_spatial_multi.py Outdated
Comment thread docs/source/reference/gallery/examples/spatial/plot_spatial_multi.py Outdated
@ukmo-huw-lewis

ukmo-huw-lewis commented Aug 28, 2026

Copy link
Copy Markdown
Contributor Author

Responded to review comments.

Updated example output: plot_spatial_multi.html

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for changes Huw! All looks good to me

@ukmo-huw-lewis
ukmo-huw-lewis merged commit f9f1374 into main Aug 28, 2026
9 checks passed
@ukmo-huw-lewis
ukmo-huw-lewis deleted the 2433-add-multi-variable-example-gallery-doc branch August 28, 2026 15:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add multi-variable example gallery doc

2 participants