uxarray.Grid.chunk

Grid.chunk(n_node='auto', n_edge='auto', n_face='auto')

Converts all arrays to dask arrays with given chunks across grid dimensions in-place.

Non-dask arrays will be converted to dask arrays. Dask arrays will be chunked to the given chunk size.

Parameters:

• n_node (int, tuple) –

  How to chunk node variables. Must be one of the following forms:

  • A blocksize like 1000.

  • A blockshape like (1000, 1000).

  • Explicit sizes of all blocks along all dimensions like ((1000, 1000, 500), (400, 400)).

  • A size in bytes, like “100 MiB” which will choose a uniform block-like shape

  • The word “auto” which acts like the above, but uses a configuration value array.chunk-size for the chunk size

  -1 or None as a blocksize indicate the size of the corresponding dimension.

• n_edge (int, tuple) –

  How to chunk edge variables. Must be one of the following forms:

  • A blocksize like 1000.

  • A blockshape like (1000, 1000).

  • Explicit sizes of all blocks along all dimensions like ((1000, 1000, 500), (400, 400)).

  • A size in bytes, like “100 MiB” which will choose a uniform block-like shape

  • The word “auto” which acts like the above, but uses a configuration value array.chunk-size for the chunk size

  -1 or None as a blocksize indicate the size of the corresponding dimension.

• n_face (int, tuple) –

  How to chunk face variables. Must be one of the following forms:

  • A blocksize like 1000.

  • A blockshape like (1000, 1000).

  • Explicit sizes of all blocks along all dimensions like ((1000, 1000, 500), (400, 400)).

  • A size in bytes, like “100 MiB” which will choose a uniform block-like shape

  • The word “auto” which acts like the above, but uses a configuration value array.chunk-size for the chunk size

  -1 or None as a blocksize indicate the size of the corresponding dimension.