chaosmagpy.data_utils.gauss_units¶
- chaosmagpy.data_utils.gauss_units(deriv=None)[source]¶
Return string of the magnetic field units given the derivative with time.
String is meant to be used in plot labels.
- Parameters:
- derivint, optional
Derivative (defaults to 0).
- Returns:
- unitsstr
Tex-style unit string.
Examples
>>> gauss_units() 'nT'
>>> gauss_units(1) '$\\mathrm{nT}/\\mathrm{yr}$'
>>> gauss_units(2) '$\\mathrm{nT}/\\mathrm{yr}^{2}$'