chaosmagpy.data_utils.save_RC_h5file

chaosmagpy.data_utils.save_RC_h5file(filepath, read_from=None)[source]

Return hdf-file of the RC index.

Parameters
filepathstr

Filepath and name of *.h5 output file.

read_fromstr, optional

Filepath of RC index *.dat. If None, the RC index will be fetched from spacecenter.dk.

Notes

Saves an h5-file of the RC index with keywords [‘time’, ‘RC’, ‘RC_e’, ‘RC_i’, ‘flag’]. Time is given in modified Julian dates 2000.

Examples

Save RC-index txt-file (RC_1997-2020_Aug_v4.dat) as file in hdf format (RC_index.h5).

>>> save_RC_h5file('RC_index.h5', read_from='RC_1997-2020_Aug_v4.dat')
Successfully saved to RC_index.h5.