HydroPopulation

class cogsworth.hydro.pop.HydroPopulation(star_particles, cluster_radius=<Quantity 3. pc>, cluster_mass=<Quantity 10000. solMass>, virial_parameter=1.0, subset=None, sampling_params={}, snapshot_type=None, **kwargs)

Bases: Population

A population of stars sampled from a hydrodynamical zoom-in snapshot

Each star particle in the snapshot is converted to a (binary) stellar population, sampled with COSMIC, with initial positions and kinematics determined based on the virial parameter and particle size.

Parameters:

star_particlesDataFrame

A table of star particles from a snapshot that contains the mass, metallicity, formation time, position and velocity of each particle, as returned by rewind_to_formation()

cluster_radiusQuantity, optional

Size of gaussian for cluster for each star particle, by default 3 * u.pc

cluster_massQuantity, optional

Mass of cluster for each star particle for calculating velocity dispersion, by default 1e4 * u.Msun

virial_parameterfloat, optional

Virial parameter for each cluster, for setting velocity dispersions, by default 1.0

subsetint or list of int, optional

If set, only use a subset of the star particles, by default use all of them. If an integer is passed, a random subset of that size is used, if a list of integers is passed, only those IDs are used.

sampling_paramsdict, optional

As in Population BUT changing the defaults to {“sampling_target”: “total_mass”, “trim_extra_samples”: True} (i.e. to sample to the total mass of the star particle)

snapshot_typestr, optional

What sort of snapshot this to infer what citations to use, by default None (i.e. don’t infer). Currently supported: “FIRE”

**kwargsvarious

Parameters to pass to Population

Methods Summary

get_citations([filename])	Print the citations for the packages/papers used in the population
perform_stellar_evolution(**kwargs)	Perform stellar evolution on systems sampled from the star particles and track their parent particles
sample_initial_binaries()	Sample initial binaries from the star particles in the snapshot
sample_initial_galaxy()	Sample the initial galactic times, positions and velocities

Methods Documentation

get_citations(filename=None)

Print the citations for the packages/papers used in the population

perform_stellar_evolution(**kwargs)

Perform stellar evolution on systems sampled from the star particles and track their parent particles

sample_initial_binaries()

Sample initial binaries from the star particles in the snapshot

sample_initial_galaxy()

Sample the initial galactic times, positions and velocities