argopy.ArgoFloat.open_dataset#
- ArgoFloat.open_dataset(name: str = 'prof', cast: bool = True, **kwargs) Dataset#
Open and decode a dataset file
The dataset is fetched and loaded in memory on every call. For performances, please consider using the
ArgoFloat.dataset()method instead.- Parameters:
name (str, optional, default = "prof") – Name of the dataset to open. It can be any key from the dictionary returned by
ArgoFloat.ls_datasets.cast (bool, optional, default = True) – Determine if the dataset variables should be cast or not. This is similar to opening the dataset directly with
xarray.open_datasetusing theengine=`argo`option. This will be ignored if the ``netCDF4` kwarg is set to True.**kwargs – All the other arguments are passed to the GDAC store open_dataset method.
- Return type:
Notes
Use the
netCDF4=Trueoption to return anetCDF4.Datasetobject instead of axarray.Dataset.