Getting started

Basic usage

The code is launched in a python interpreter by calling the Simulator bject :

from snsim import Simulator

# Initialisation with yaml file
sim = Simulator('yaml_cfg_file.yml')

# or with dic
sim = Simulator(cfg_dic)

# Simulation
sim.simulate()

The result is stored in sim.sn_sample object . Simulated lc and metadata are given by :

sim.sn_sample.sim_lcs.loc[i] # sn_sample.sim_lcs is a pandas.DataFrame object
sim.sn_sample.sim_lcs.meta[i] # metadata are stored in a dict in sn_sample.sim_lcs.attrs but there is a shortcut sim_lcs.meta

#  For more information :
help(sim.sn_sample)

The basic list of ligth-curves metadata is given in the following table :

zobs	sim_t0	vpec	zcos	zpec	z2cmb	zCMB	ra [rad]	dec [rad]	ID	sim_mu	mag_sct
Observed redshift	Peak time	Peculiar velocity	Cosmological redshift	Peculiar velocity redshift	Redshift due to our peculiar motion	CMB frame redshift	Right Ascention	Declination	Identifiant	Distance modulus	Coherent scattering

If you use SALT2/3 model you add some arguments to metadata:

sim_x0	sim_x1	sim_c	sim_mb
Normalization parameter	Stretch parameter	color parameter	SN magnitude in restframe Bessell B

Moreover, if you use a scattering model like G10 or C11 the random seed used is kept in the meta too.