isotopylog.HeatingExperiment.from_csv

classmethod HeatingExperiment.from_csv(file, calibration='Aea21', culled=True, cull_sig=1)

Imports data from a csv file and creates a HeatingExperiment object from those data.

Parameters:
  • file (string or pd.DataFrame) –
  • calibration (string or LambdaType) –

    The D-T calibration curve to use, either from the literature or as a user-inputted lambda function. If from the literature for D47 clumps, options are:

    'PH12': for Passey and Henkes (2012) Eq. 4 (CDES 25C)

    'SE15': for Stolper and Eiler (2015) Fig. 3 (Ghosh 25C)

    'Bea17': for Bonifacie et al. (2017) Eq. 2 (CDES 90C)

    'Aea21': for Anderson et al. (2021) Eq. 1 (I-CDES)

    If as a lambda function, must have T in Kelvin. It is recommended to run each calibration only using its native reference frame (denoted in parentheses); although these will be automatically adjusted to different reference frames, there is no guarantee that this conversion is accurate for all analytical setups. In contrast, lambda functions must be reference-frame specific. Defaults to 'Aea21'.

  • culled (boolean) – Tells the function whether or not to cull data following the approach of Passey and Henkes (2012). Defaults to True.
  • cull_sig (int or float) – The number of standard deviations deemed to be the cutoff threshold. For example, if cull_sig = 1, then drops everything within 1 sigma of Deq.
Returns:

he – The HeatingExperiment object.
Return type:

isotopylog.HeatingExperiment
Raises:
  • KeyError – If the inputted calibration is not an acceptable string or a lambda function.
  • KeyError – If the inputted csv file does not contain any of the necessary columns.
  • TypeError – If the file parameter is not a path string or pandas DataFrame.
  • ValueError – If the inputted csv file doesn’t contain appropriate data for CO47 clumps.

Warning

UserWarning
If trying to cull data but no D uncertainty is inputted. Culling requires D uncertainty to check approach to equilibrium following Passey and Henkes (2012).

See also

isotopylog.HeatingExperiment()
The HeatingExperiment class that is created by this function.

Examples

Generating a HeatingExperiment instance by extracting data from a csv file:

#setting a string with the file name
file = 'string_with_file_name.csv'

#make HeatingExperiment instance without culling data
he = ipl.HeatingExperiment.from_csv(file, culled = False)

#or, cull the data that are too close to equilibrium (see PH12)
he = ipl.HeatingExperiment.from_csv(
        file,
        culled = True,
        cull_sig = 1 #can make higher for a more liberal cutoff
        )

References

[1] Passey and Henkes (2012) Earth Planet. Sci. Lett., 351, 223–236.

[2] Stolper and Eiler (2015) Am. J. Sci., 315, 363–411.

[3] Daëron et al. (2016) Chem. Geol., 442, 83–96.

[4] Bonifacie et al. (2017) Geochim. Cosmochim. Ac., 200, 255–279.

[5] Anderson et al. (2021) Geophys. Res. Lett., 48, e2020GL092069.