argopy.stores.ArgoKerchunker.to_reference

argopy.stores.ArgoKerchunker.to_reference#

ArgoKerchunker.to_reference(ncfile: str | Path, fs=None, overwrite: bool = False)[source]#

Return zarr reference data for a given netcdf file path

Return data from the instance store if available, otherwise trigger ArgoKerchunker.translate() (which save data on the instance data store).

This is the method to use in argopy file store methods ArgoStoreProto.open_dataset() to implement laziness.

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

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

Return type:

dict