argopy.stores.ArgoKerchunker.nc2reference

ArgoKerchunker.nc2reference(ncfile: str | Path, fs=None, chunker: Literal['auto', 'cdf3', 'hdf5'] = 'auto')

Compute reference data for a netcdf file (kerchunk json data)

This method is intended to be used internally, since it’s not using the kerchunk reference store.

Users should rather use the to_reference() method to avoid to recompute reference data when available on the ArgoKerchunker instance.

Parameters:

• ncfile (Union[str, Path]) – Path to a netcdf file to process

• fs (None) – An argopy file store, inheriting from ArgoStoreProto.

• chunker (Literal['auto', 'cdf3', 'hdf5'] = 'auto') –

  Define the kerchunker formater to use. Two formater are available: kerchunk.netCDF3.NetCDF3ToZarr or kerchunk.hdf.SingleHdf5ToZarr:

  • ’auto’: detect and select formater for each netcdf of the ncfiles

  • ’cdf3’: impose use of kerchunk.netCDF3.NetCDF3ToZarr

  • ’hdf5’: impose use of kerchunk.hdf.SingleHdf5ToZarr

Return type:

dict