erlab.io.utilities

Functions

fix_attr_format(da)	Discards attributes that are incompatible with the netCDF4 file format.
get_files(directory[, extensions, contains, ...])	Return a list of files in a directory with the given extensions.
load_hdf5(filename, **kwargs)	Load data from an HDF5 file saved with save_as_hdf5.
open_hdf5(filename, **kwargs)	Open data from an HDF5 file saved with save_as_hdf5.
save_as_hdf5(data, filename[, igor_compat])	Save data in HDF5 format.
save_as_netcdf(data, filename, **kwargs)	Save data in netCDF4 format.
showfitsinfo(path)	Print raw metadata from a .fits file.

erlab.io.utilities.get_files(directory, extensions=None, contains=None, notcontains=None)

Return a list of files in a directory with the given extensions.

Parameters:

• directory – Target directory.

• extensions (Sequence[str] | None) – List of extensions to filter for. If not provided, all files are returned.

• contains (str | None) – String to filter for in the file names.

• notcontains (str | None) – String to filter out of the file names.

Returns:

files – List of files in the directory.

Return type:

list of str

erlab.io.utilities.load_hdf5(filename, **kwargs)

Load data from an HDF5 file saved with save_as_hdf5.

This is a thin wrapper around xarray.load_dataarray and xarray.load_dataset.

Parameters:

• filename (str | PathLike) – The path to the HDF5 file.

• **kwargs – Extra arguments to xarray.load_dataarray or xarray.load_dataset.

Returns:

The loaded data.

Return type:

xarray.DataArray or xarray.Dataset

erlab.io.utilities.open_hdf5(filename, **kwargs)

Open data from an HDF5 file saved with save_as_hdf5.

This is a thin wrapper around xarray.open_dataarray and xarray.open_dataset.

Parameters:

• filename (str | PathLike) – The path to the HDF5 file.

• **kwargs – Extra arguments to xarray.open_dataarray or xarray.open_dataset.

Returns:

The opened data.

Return type:

xarray.DataArray or xarray.Dataset

erlab.io.utilities.save_as_hdf5(data, filename, igor_compat=True, **kwargs)

Save data in HDF5 format.

Parameters:

• data (DataArray | Dataset) – xarray.DataArray to save.

• filename (str | PathLike) – Target file name.

• igor_compat (bool) – (Experimental) Make the resulting file compatible with Igor’s HDF5OpenFile for DataArrays with up to 4 dimensions. A convenient Igor procedure is included in the repository. Default is True.

• **kwargs – Extra arguments to xarray.DataArray.to_netcdf: refer to the xarray documentation for a list of all possible arguments.

erlab.io.utilities.save_as_netcdf(data, filename, **kwargs)

Save data in netCDF4 format.

Discards invalid netCDF4 attributes and produces a warning.

Parameters:

• data (DataArray) – xarray.DataArray to save.

• filename (str | PathLike) – Target file name.

• **kwargs – Extra arguments to xarray.DataArray.to_netcdf: refer to the xarray documentation for a list of all possible arguments.

erlab.io.utilities.showfitsinfo(path)

Print raw metadata from a .fits file.

Parameters:

path (str | PathLike) – Local path to .fits file.