Cooling Model Reader API

class WDPhotTools.cooling_model_reader.CoolingModelReader[source]

A reader object to handle the input of different cooling models

compute_cooling_age_interpolator(interpolator='CT', kwargs_for_RBF={}, kwargs_for_CT={})[source]

Compute the callable CloughTocher2DInterpolator taking (logL, m) and returning the cooling time of the WDs. It needs to use float64 or it runs into float-point error at very faint lumnosity.

Parameters:

  • interpolator (str (Default: 'CT')) – Choose between ‘RBF’ and ‘CT’.

  • kwargs_for_RBF (dict (Default: {"neighbors": None,) – “smoothing”: 0.0, “kernel”: “thin_plate_spline”, “epsilon”: None, “degree”: None,}) Keyword argument for the interpolator. See scipy.interpolate.RBFInterpolator.

  • kwargs_for_CT (dict (Default: {'fill_value': -np.inf,) – ‘tol’: 1e-10, ‘maxiter’: 100000}) Keyword argument for the interpolator. See scipy.interpolate.CloughTocher2DInterpolator.

get_cooling_model(model, mass_range='all')[source]

Choose the specified cooling model for the chosen mass range.

Parameters:

  • model (str) – Name of the cooling model as in the model_list.

  • mass_range (str (Default: 'all')) – The mass range in which the cooling model should return. The ranges are defined as <0.5, 0.5-1.0 and >1.0 solar masses.

list_cooling_model(print_to_screen=True)[source]

Print the formatted list of available cooling models.

Parameters:

print_to_screen (bool (Default: True)) – Set to True to print the list of cooling models to screen.

Returns:

The names and references of the cooling models.

Return type:

model_list

list_cooling_parameters(model, print_to_screen=True)[source]

Print the formatted list of parameters available for the specified cooling models.

Parameters:

  • model (str) – Name of the cooling model as in the model_list.

  • print_to_screen (bool (Default: True)) – Set to True to print the cooling model parameters to screen.

Returns:

  • mass – WD mass available in the specified model.

  • column_names – Available parameters in the specified model.

  • column_units – Unites of the parameters in the specified model.

set_high_mass_cooling_model(model)[source]

Set the WD cooling model.

Parameters:

model (str (Default: 'montreal_co_da_20')) –

Choice of WD cooling model:

  1. ’montreal_co_da_20’ - Bedard et al. 2020 CO DA

  2. ’montreal_co_db_20’ - Bedard et al. 2020 CO DB

  3. ’lpcode_one_da_07’ - Althaus et al. 2007 ONe DA

  4. ’lpcode_one_da_19’ - Camisassa et al. 2019 ONe DA

  5. ’lpcode_one_db_19’ - Camisassa et al. 2019 ONe DB

  6. ’lpcode_da_20’ - Althaus et al. 2013, Camisassa et al. 2016,

    Camisassa et al. 2019

  7. ’lpcode_db_20’ - Camisassa et al. 2017, Camisassa et al. 2019

  8. ’basti_co_da_10’ - Salaris et al. 2010 CO DA

  9. ’basti_co_db_10’ - Salaris et al. 2010 CO DB

  10. ’basti_co_da_10_nps’ - Salaris et al. 2010 CO DA,

    no phase separation

  11. ’basti_co_db_10_nps’ - Salaris et al. 2010 CO DB,

    no phase separation

  12. ’mesa_one_da_18’ - Lauffer et al. 2018 ONe DA

  13. ’mesa_one_db_18’ - Lauffer et al. 2018 ONe DB

The naming convention follows this format: [model]_[core composition]_[atmosphere]_[publication year] where a few models continue to have extra property description terms trailing after the year, currently they are either the progenitor metallicity or the (lack of) phase separation in the evolution model.

set_intermediate_mass_cooling_model(model)[source]

Set the WD cooling model.

Parameters:

model (str (Default: 'montreal_co_da_20')) –

Choice of WD cooling model:

  1. ’montreal_co_da_20’ - Bedard et al. 2020 CO DA

  2. ’montreal_co_db_20’ - Bedard et al. 2020 CO DB

  3. ’lpcode_co_da_10_z001’ - Renedo et al. 2010 CO DA Z=0.01

  4. ’lpcode_co_da_10_z0001’ - Renedo et al. 2010 CO DA Z=0.001

  5. ’lpcode_co_da_15_z00003’ - Althaus et al. 2015 DA Z=0.00003

  6. ’lpcode_co_da_15_z0001’ - Althaus et al. 2015 DA Z=0.0001

  7. ’lpcode_co_da_15_z0005’ - Althaus et al. 2015 DA Z=0.0005

  8. ’lpcode_co_da_17_y04’ - Althaus et al. 2017 DB Y=0.4

  9. ’lpcode_co_db_17’ - Camisassa et al. 2017 DB

  10. ’lpcode_da_20’ - Althaus et al. 2013, Camisassa et al. 2016, Camisassa et al. 2019

  11. ’lpcode_db_20’ - Camisassa et al. 2017, Camisassa et al. 2019

  12. ’basti_co_da_10’ - Salaris et al. 2010 CO DA

  13. ’basti_co_db_10’ - Salaris et al. 2010 CO DB

  14. ’basti_co_da_10_nps’ - Salaris et al. 2010 CO DA, no phase separation

  15. ’basti_co_db_10_nps’ - Salaris et al. 2010 CO DB, no phase separation

The naming convention follows this format: [model]_[core composition]_[atmosphere]_[publication year] where a few models continue to have extra property description terms trailing after the year, currently they are either the progenitor metallicity or the (lack of) phase separation in the evolution model.

set_low_mass_cooling_model(model)[source]

Set the WD cooling model.

Parameters:

model (str (Default: 'montreal_co_da_20')) –

Choice of WD cooling model:

  1. ’montreal_co_da_20’ - Bedard et al. 2020 CO DA

  2. ’montreal_co_db_20’ - Bedard et al. 2020 CO DB

  3. ’lpcode_he_da_07’ - Panei et al. 2007 He DA

  4. ’lpcode_co_da_07’ - Panei et al. 2007 CO DA

  5. ’lpcode_he_da_09’ - Althaus et al. 2009 He DA

  6. ’lpcode_da_20’ - Althaus et al. 2013, Camisassa et al. 2016, Camisassa et al. 2019

The naming convention follows this format: [model]_[core composition]_[atmosphere]_[publication year] where a few models continue to have extra property description terms trailing after the year, currently they are either the progenitor metallicity or the (lack of) phase separation in the evolution model.