MetOffice / MetOffice/cube_helper

Give clearer examples of loading PP files

Open Beginner friendly
#57 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
3
Forks
4
PR merge metrics
No merged PRs in 30d

Description

Cube_helper was designed to help with loading netCDF from CMIP and so it assumes that each file has an 'nc' suffix. To load PP files something like:

test2 = ch.load([file], 'pp')

is required. This is documented at https://cube-helper.readthedocs.io/en/v2.2.3/Cube%20Helper%20Module.html#cube_helper.load but isn't clear in the Quickstart or Tutorial. A quick example should be added to these two sections of the documentation.

Contributor guide

Open the contributing guide

Research direction

Start by reading the existing cube_helper.load documentation and then compare the Quickstart and Tutorial sections. Add a concise example showing how to load a PP file with the required format argument in both sections. Done means readers can find and understand the PP-loading example in each location.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.