Match

cosmic.Match.match(dataCm)[source]

Performs the Match calculation in Eq. 1 of Breivik & Larson (2018)

Parameters:
dataCmlist

List of two cumulative data sets for a single paramter

Returns:
matchlist

List of matches for each cumulative data set

binwidthfloat

Binwidth of histograms used for match computation

cosmic.Match.perform_convergence(conv_params, conv_1, conv_2, log_file)[source]

Performs the convergence calculations for each convergence parameter and binary state

Parameters:
conv_paramsdict

List of user supplied convergence parameters

conv_1DataFrame

Cumulative data set of conv arrays

conv_2DataFrame

Most recent data set of conv array from most recent BSE run

log_filefile write

File to log matches or if the convergence params are not appropriate e.g. eccentricity for a disrupted system

Returns:
matcharray

Matches for each cumulative data set