NCAS-CMS / NCAS-CMS/cf-plot

include example file

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

Nobody has claimed this yet.

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

Description

The example in the cf-plot docs assume that the user has access to the example file on the Reading systems. It might be worth producing a small example netCDF file (with some heavy subsetting, just big enough to produce a plot), and including it in the distribution, with the docs changed to refer to it. Thanks.

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 by reviewing the cf-plot documentation references to example files and the project’s distribution setup. Identify how a small, subsetted netCDF example can be included and where the documentation points users to it; done means the packaged example works for producing a plot and the docs no longer depend on Reading systems access.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data-visualization, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.