Binaries

ocelot.model.binaries.MoeDiStefanoMultiplicityRelation

Bases: BaseBinaryStarModelWithEccentricities

__init__()

An interpolated implementation of the MoeDiStefano17 multiplicity relations, plus DucheneKraus+13 for stars below 1 MSun.

multiplicity_fraction(masses)

Calculate multiplicity fraction.

companion_star_frequency(masses)

Calculate companion star frequency.

random_mass_ratio(masses, seed=None)

Calculate a random mass ratio.

random_binary(masses, seed=None)

Return random binary star masses, periods, and eccentricities.

ocelot.model.binaries.BaseBinaryStarModel

Bases: ABC

A binary star model abstract base class for models that implement MF, CSF, and q.

random_mass_ratio(masses, seed=None) abstractmethod

Returns a random binary star mass ratio q.

ocelot.model.binaries.BaseBinaryStarModelWithPeriods

Bases: BaseBinaryStarModel

An extension of BinaryStarModel for models that also include period modelling, allowing for binaries to be classed as resolved or unresolved.

random_mass_ratio(masses, seed=None) abstractmethod

Returns a random binary star mass ratio q.

random_binary(masses, seed=None) abstractmethod

Returns a random binary star mass ratio q and a period in days.

ocelot.model.binaries.BaseBinaryStarModelWithEccentricities

Bases: BaseBinaryStarModelWithPeriods

An extension of BinaryStarModelWithPeriods for models that also include eccentricities, allowing for binaries to be classed as resolved or unresolved.

random_mass_ratio(masses, seed=None) abstractmethod

Returns a random binary star mass ratio q.

random_binary(masses, seed=None) abstractmethod

Returns a random binary star mass ratio q, a period in days, and an eccentricity.