anu_ctlab_io.netcdf

Read data from the ANU CTLab netcdf data format.

This is an optional extra module, and must be explicitly installed to be used (e.g., pip install anu_ctlab_io[netcdf]).

Package Contents

anu_ctlab_io.netcdf.dataset_from_netcdf(path, *, parse_history=True, **kwargs)

Loads a Dataset from the path to a netcdf.

This method is used by Dataset.from_path, by preference call that constructor directly.

Parameters:

  • Path – The path to the netcdf or directory of split netcdf blocks to be loaded.

  • parse_history (bool) – Whether to parse the history of the netcdf file. Defaults to True, but disableable because the parser is currently not guaranteed to succeed.

  • kwargs (Any) – Currently this method consumes no kwargs, but will pass provided kwargs to Xarray.open_mfdataset.

  • path (pathlib.Path)

Raises:

lark.exceptions.UnexpectedInput – Raised if parse_history=True and the parser fails to parse the specific history provided.

Return type:

anu_ctlab_io._dataset.Dataset