`snews_cs.cs_utils`¶

Example initial dosctring

Module Contents¶

SNEWS format datetime objects

`set_env`(env_path=None)	Set environment parameters
`get_logger`(scriptname, logfile_name)	Logger
`data_cs_alert`(p_vals=None, nu_times=None, detector_names=None, p_val_avg=None, sub_list_num=None)	Default alert message data

snews_cs.cs_utils.set_env(env_path=None)[source]¶

Set environment parameters

Parameters: env_path (str, (optional)) – path for the environment file. Use default settings if not given

class snews_cs.cs_utils.TimeStuff(env_path=None)[source]¶

SNEWS format datetime objects

str_to_datetime(self, nu_time, fmt='%y/%m/%d %H:%M:%S')[source]¶: string to datetime object

str_to_hr(self, nu_time, fmt='%H:%M:%S:%f')[source]¶: string to datetime hour object

snews_cs.cs_utils.get_logger(scriptname, logfile_name)[source]¶: Logger

Note

Deprecated

snews_cs.cs_utils.data_cs_alert(p_vals=None, nu_times=None, detector_names=None, p_val_avg=None, sub_list_num=None)[source]¶

Default alert message data

Parameters

p_vals (list) – list with p-values of the observations involved in the alert
nu_time (list) – list of neutrino arrival times
detector_names (list) – list of ids of the detectors involved in the alert
p_val_avg (float) – Naive, average p value
sub_list_num (int) – The sublist number of the triggered alert

Returns

dictionary of the complete alert data

Return type

dict