diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index 7073ba49c1..35280d5cd8 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -7,7 +7,11 @@ This file contains a high-level description of this package's evolution. Release ## 4.8.2 - TBD + * [Bug Fix] Get "make distcheck" to work See [Github #/2343](https://github.com/Unidata/netcdf-c/pull/2343). +* [Enhancement] Allow the read/write of JSON-valued Zarr attributes to allow +for domain specific info such as used by GDAL/Zarr. See [Github #????](https://github.com/Unidata/netcdf-c/pull/????). +* [Enhancement] Turn on the XArray convention for NCZarr files by default. WARNING, this means that the mode should explicitly specify nczarr" or "zarr" even if "xarray" or "noxarray" is specified. See [Github #2257](https://github.com/Unidata/netcdf-c/pull/2257). * [Enhancement] Update the documentation to match the current filter capabilities See [Github #2249](https://github.com/Unidata/netcdf-c/pull/2249). * [Enhancement] Support installation of pre-built standard filters into user-specified location. See [Github #2318](https://github.com/Unidata/netcdf-c/pull/2318). * [Enhancement] Improve filter support. More specifically (1) add nc_inq_filter_avail to check if a filter is available, (2) add the notion of standard filters, (3) cleanup szip support to fix interaction with NCZarr. See [Github #2245](https://github.com/Unidata/netcdf-c/pull/2245). diff --git a/docs/nczarr.md b/docs/nczarr.md index 2582cb55c1..94b78e82cd 100644 --- a/docs/nczarr.md +++ b/docs/nczarr.md @@ -136,16 +136,18 @@ Note that It should be the case that zipping a _file_ format directory tree will produce a file readable by the _zip_ storage format, and vice-versa. -By default, _mode=zarr_ also supports the XArray _\_ARRAY\_DIMENSIONS_ convention. The _noxarray_ mode tells the library to disable the XArray support. +By default, the XArray convention is supported and used for +both NCZarr files and pure Zarr files. This +means that every variable in the root group whose named dimensions +are also in the root group will have an attribute called +*\_ARRAY\_DIMENSIONS* that stores those dimension names. +The _noxarray_ mode tells the library to disable the XArray support. The netcdf-c library is capable of inferring additional mode flags based on the flags it finds. Currently we have the following inferences. - -- _xarray_ => _zarr_ -- _noxarray_ => _zarr_ - _zarr_ => _nczarr_ -So for example: ````...#mode=noxarray,zip```` is equivalent to this. -````...#mode=nczarr,zarr,noxarray,zip +So for example: ````...#mode=zarr,zip```` is equivalent to this. +````...#mode=nczarr,zarr,zip ````