SFH sampling (sfh)#

The sfh module covers classes for a variety of models for the galactic star formation history, each of which inherits from StarFormationHistory class. You can read more about each of these models below.

Inheritance diagram of cogsworth.sfh

Classes#

StarFormationHistory(**kwargs)

Class for a generic galactic star formation history model from which to sample

CompositeStarFormationHistory(components, ...)

A star formation history that is a combination of multiple other star formation histories.

DistributionFunctionBasedSFH(potential[, df])

A star formation history based on a distribution function.

Wagg2022([tsfr, alpha, Fm, gradient, Rnow, ...])

A semi-empirical model defined in Wagg+2022 (see Figure 1 and Section 2.2.1 for a detailed explanation.), heavily based on Frankel+2018.

Frankel2018SFH([scale_length, scale_height, ...])

A star formation history for a component of the Milky Way, based on Frankel+2018.

LowAlphaDiscWagg2022(**kwargs)

A star formation history for the low-alpha disc of the Milky Way, used in Wagg+2022

HighAlphaDiscWagg2022(**kwargs)

A star formation history for the high-alpha disc of the Milky Way, used in Wagg+2022

BulgeWagg2022(**kwargs)

A star formation history for the bulge of the Milky Way used in Wagg+2022

MilkyWayBarSormani2022(potential[, kappa, ...])

A star formation history for the Milky Way bar, based on Sormani+2022.

BurstUniformDisc([t_burst, z_max, R_max, Z_all])

An extremely simple star formation history, with all stars formed at t_burst in a uniform disc with height z_max and radius R_max disc, all with metallicity Z.

ConstantUniformDisc([t_burst, z_max, R_max, ...])

A simple star formation history, with all stars formed at a constant rate between t_burst and the present day in a uniform disc with height z_max and radius R_max disc, all with metallicity Z.

ConstantPlummerSphere(tau_min, tau_max, ...)

A simple star formation history, with all stars formed at a constant rate between tau_min and tau_max in a Plummer sphere potential, all with metallicity Z.

SandersBinney2015(potential[, time_bins, ...])

Star formation history model based on a Quasi-Isothermal Disc distribution function from Sanders & Binney 2015.

SpheroidalDwarf(J_0_star, alpha, eta, ...[, ...])

An action-based model for dwarf spheroidal galaxies and globular clusters Pascale+2019.

CarinaDwarf(**kwargs)

A model for the Carina dwarf spheroidal galaxy based on Pascale+2019.

Functions#

load(file_name[, key])

Load an entire class from storage.

concat(*sfhs)

Concatenate multiple StarFormationHistory objects together.