get_synchronic_map_data

get_synchronic_map_data#

get_synchronic_map_data(hdf='.h5')[source]#

Fetch the synchronic map data file.

Warning

Synchronic map data is only available in HDF5 format. Furthermore, unlike the other example data files, synchronic map data files contain additional datasets beyond the primary data and scales.

Parameters:
hdfHdfExtType, optional

The HDF file format to fetch. Accepted values are '.h5' for HDF5 and '.hdf' for HDF4. Default is '.h5'.

Returns:
outstr

Local path to the downloaded (and cached) synchronic map data file.

Examples

>>> from psi_io import data
>>> path = data.get_synchronic_map_data()
>>> path.endswith(".h5")
True
Contents