NCAS-CMS / NCAS-CMS/cf-python

Clarity in documentation and code around chunksizes

Open
#779 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

API review (4.0.0) enhancement
Dominant language
Python
Stars
150
Forks
23
Avg merge
1d 11h
Merged PRs (30d)
2

Description

  1. If you search the document for chunksizes you get a lot of stuff about dask chunk sizes first. Can be confusing if you are interested in variable chunksizes.

  2. The method v.data.set_nc_hdf5_chunksizes actually sets the chunk shape, not the volume/size.

E.g. the word size is clearly about the volume, as can be seen from the documentation:

https://docs.unidata.ucar.edu/nug/current/netcdf_perf_chunking.html says "Currently the netCDF default chunk size is 4MiB The current default chunking strategy of the netCDF library is to balance access time alongany of a variable's dimensions, by using chunk shapes similar to the shape of the entire variable but small enough that the resulting chunk size is less than or equal to the default chunk size."

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 searching the documentation and code for “chunksizes” and inspect v.data.set_nc_hdf5_chunksizes. Compare the references to Dask chunk sizes with variable chunk shapes and sizes. Done means the terminology and documentation clearly distinguish these concepts and accurately describe what the method sets.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.