redback 1.0.2__py3-none-any.whl → 1.0.31__py3-none-any.whl

redback/__init__.py

@@ -4,5 +4,5 @@ from redback.transient import afterglow, kilonova, prompt, supernova, tde
 from redback.sampler import fit_model
 from redback.utils import setup_logger
 
-__version__ = "1.0.2"
+__version__ = "1.0.31"
 setup_logger(log_level='info')

redback/constraints.py

@@ -65,6 +65,21 @@ def general_magnetar_powered_sn_constraints(parameters):
     converted_parameters['erot_constraint'] = kinetic_energy/rotational_energy
     return converted_parameters
     
+def vacuum_dipole_magnetar_powered_supernova_constraints(parameters):
+    """
+    Constraint so that magnetar rotational energy is smaller than some number
+
+    :param parameters: dictionary of parameters
+    :return: converted_parameters dictionary where the violated samples are thrown out
+    """
+    converted_parameters = parameters.copy()
+    l0 = parameters['l0']
+    tau = parameters['tau_sd']
+    rotational_energy = l0*tau
+    # ensure rotational energy is less than the maximum spin down energy
+    converted_parameters['erot_constraint'] = rotational_energy/1e53
+    return converted_parameters        
+    
 def general_magnetar_powered_supernova_constraints(parameters):
     """
     Constraint so that magnetar rotational energy is smaller than some number

redback/eos.py

@@ -78,6 +78,7 @@ class PiecewisePolytrope(object):
         radius, mass, k2 = lalsim.SimNeutronStarTOVODEIntegrate(central_pressure, polytrope)
 
         Lambda = (2 / 3) * k2 * (cc.c.si.value ** 2 * radius / (cc.G.si.value * mass)) ** 5
+        mass = mass / cc.M_sun.si.value
         return mass, Lambda
 
     def lambda_array_of_central_pressure(self, central_pressure_array, maximum_mass_lower_limit=2.01):

redback/get_data/fink.py

@@ -45,7 +45,7 @@ class FinkDataGetter(DataGetter):
         :return: The fink raw data url.
         :rtype: str
         """
-        return "https://fink-portal.org/api/v1/objects"
+        return "https://api.fink-portal.org/api/v1/objects"
 
     @property
     def objectId(self) -> str:

redback/model_library.py

@@ -1,13 +1,13 @@
 from redback.transient_models import afterglow_models, \
     extinction_models, kilonova_models, fireball_models, \
     gaussianprocess_models, magnetar_models, magnetar_driven_ejecta_models, phase_models, phenomenological_models, \
-    prompt_models, shock_powered_models, supernova_models, tde_models, integrated_flux_afterglow_models, combined_models
+    prompt_models, shock_powered_models, supernova_models, tde_models, integrated_flux_afterglow_models, combined_models, general_synchrotron_models
 from redback.utils import get_functions_dict
 
 modules = [afterglow_models, extinction_models, fireball_models,
            gaussianprocess_models,  integrated_flux_afterglow_models, kilonova_models,
            magnetar_models, magnetar_driven_ejecta_models,
-           phase_models, phenomenological_models, prompt_models, shock_powered_models, supernova_models, tde_models, combined_models]
+           phase_models, phenomenological_models, prompt_models, shock_powered_models, supernova_models, tde_models, combined_models, general_synchrotron_models]
 
 all_models_dict = dict()
 modules_dict = dict()

redback/priors/bazin_sne.prior

@@ -0,0 +1,5 @@
+aa = LogUniform(1e-15,1e15,name='aa', latex_label = r'$A$')
+bb = LogUniform(1e-15,1e15,name='bb', latex_label = r'$B$')
+t0 = Uniform(0,50,name='t0', latex_label = r'$t_0$')
+tau_rise = Uniform(0.01, 50, name='tau_rise', latex_label = r'$\\tau_{\\mathrm{rise}}$')
+tau_fall = Uniform(1, 300, name='tau_fall', latex_label = r'$\\tau_{\\mathrm{fall}}$')

redback/priors/csm_shock_and_arnett.prior

@@ -0,0 +1,11 @@
+redshift = Uniform(0.01, 1, 'redshift', latex_label=r'$z$')
+mej = LogUniform(1e-4, 30, 'mej', latex_label = r'$M_{\mathrm{ej}}~(M_\odot)$')
+f_nickel = LogUniform(1e-3,1,name='f_nickel', latex_label = r'$f_{\mathrm{Ni}}$')
+csm_mass = LogUniform(1e-3, 5, 'csm_mass', latex_label=r'$M_{\mathrm{CSM}}~(M_{\odot})$')
+v_min = LogUniform(1e3, 3e4, 'vej', latex_label = r'$v_{\mathrm{ej}}~(\mathrm{km}/\mathrm{s})$')
+beta = Uniform(0.4, 0.5, 'beta', latex_label=r'$\\beta$')
+kappa = Uniform(0.01, 1, 'kappa', latex_label = r'$\\kappa~(\mathrm{cm}^{2}/\mathrm{g})$')
+shell_radius = Uniform(1e-2, 10, 'shell_radius', latex_label=r'$R_{\mathrm{shell}}~(10^{14}~\mathrm{cm})$')
+shell_width_ratio = Uniform(0.1, 0.5, 'shell_width_ratio', latex_label=r'$\\Delta~R_{\mathrm{shell}}/R_{\mathrm{shell}}$')
+kappa_gamma = LogUniform(1e-4, 1e4, 'kappa_gamma', latex_label = r'$\\kappa_{\\gamma}~(\mathrm{cm}^{2}/\mathrm{g})$')
+temperature_floor = LogUniform(1e3,1e5,name = 'temperature_floor', latex_label = r'$T_{\mathrm{floor}}~(\mathrm{K})$')

redback/priors/csm_shock_and_arnett_bolometric.prior

@@ -0,0 +1,10 @@
+mej = LogUniform(1e-4, 30, 'mej', latex_label = r'$M_{\mathrm{ej}}~(M_\odot)$')
+f_nickel = LogUniform(1e-3,1,name='f_nickel', latex_label = r'$f_{\mathrm{Ni}}$')
+csm_mass = LogUniform(1e-3, 5, 'csm_mass', latex_label=r'$M_{\mathrm{CSM}}~(M_{\odot})$')
+v_min = LogUniform(1e3, 3e4, 'vej', latex_label = r'$v_{\mathrm{ej}}~(\mathrm{km}/\mathrm{s})$')
+beta = Uniform(0.4, 0.5, 'beta', latex_label=r'$\\beta$')
+kappa = Uniform(0.01, 1, 'kappa', latex_label = r'$\\kappa~(\mathrm{cm}^{2}/\mathrm{g})$')
+shell_radius = Uniform(1e-2, 10, 'shell_radius', latex_label=r'$R_{\mathrm{shell}}~(10^{14}~\mathrm{cm})$')
+shell_width_ratio = Uniform(0.1, 0.5, 'shell_width_ratio', latex_label=r'$\\Delta~R_{\mathrm{shell}}/R_{\mathrm{shell}}$')
+kappa_gamma = LogUniform(1e-4, 1e4, 'kappa_gamma', latex_label = r'$\\kappa_{\\gamma}~(\mathrm{cm}^{2}/\mathrm{g})$')
+temperature_floor = LogUniform(1e3,1e5,name = 'temperature_floor', latex_label = r'$T_{\mathrm{floor}}~(\mathrm{K})$')

redback/priors/csm_shock_breakout.prior

@@ -0,0 +1,7 @@
+redshift = Uniform(0.01, 1, 'redshift', latex_label=r'$z$')
+csm_mass = LogUniform(1e-3, 2, 'csm_mass', latex_label=r'$M_{\mathrm{CSM}}~(M_{\odot})$')
+v_min = LogUniform(1e3, 3e4, 'vej', latex_label = r'$v_{\mathrm{ej}}~(\mathrm{km}/\mathrm{s})$')
+beta = Uniform(0.4, 0.5, 'beta', latex_label=r'$\\beta$')
+kappa = Uniform(0.01, 1, 'kappa', latex_label = r'$\\kappa~(\mathrm{cm}^{2}/\mathrm{g})$')
+shell_radius = Uniform(1e-2, 10, 'shell_radius', latex_label=r'$R_{\mathrm{shell}}~(10^{14}~\mathrm{cm})$')
+shell_width_ratio = Uniform(0.1, 0.5, 'shell_width_ratio', latex_label=r'$\\Delta~R_{\mathrm{shell}}/R_{\mathrm{shell}}$')

redback/priors/nicholl_bns.prior

@@ -8,7 +8,8 @@ mtov = Uniform(2.05, 2.4, 'mtov', latex_label = r'$M_{\mathrm{TOV}}~(M_\odot)$')
 epsilon = Uniform(0.05, 0.6, 'zeta', latex_label = r'$\\epsilon$')
 alpha = Uniform(0.1, 1, 'alpha', latex_label = r'$\\alpha$')
 cos_theta = Uniform(0.0, 1.0, 'cos_theta', latex_label = r'$\cos~\\theta$')
-cos_theta_cocoon = Uniform(0.707, 1.0, 'cos_theta_cocoon', latex_label = r'$\cos~\\theta_{\mathrm{cocoon}}$')
+cos_theta_open = Uniform(0.707, 0.866, 'cos_theta_open', latex_label = r'$\cos~\\theta_{\mathrm{open}}$')
+cos_theta_cocoon = Uniform(0.866, 1.0, 'cos_theta_cocoon', latex_label = r'$\cos~\\theta_{\mathrm{cocoon}}$')
 temperature_floor_1 = LogUniform(100, 6000, 'temperature_floor_1', latex_label = r'$T_{\mathrm{floor}~1}$ (K)')
 temperature_floor_2 = LogUniform(100, 6000, 'temperature_floor_2', latex_label = r'$T_{\mathrm{floor}~2}$ (K)')
 temperature_floor_3 = LogUniform(100, 6000, 'temperature_floor_3', latex_label = r'$T_{\mathrm{floor}~3}$ (K)')

redback/priors/pwn.prior

@@ -0,0 +1,7 @@
+redshift = Uniform(1e-6,3,name='redshift', latex_label = r'$z$')
+l0 = LogUniform(1e40, 1e50, 'l0', latex_label = r'$L_{\mathrm{0}} [erg s^{-1}]$')
+tau_sd = LogUniform(1e2, 1e8, 'tau_sd', latex_label = r'$t_{\mathrm{SD}} [s]$')
+nn = LogUniform(1.5, 10, 'nn', latex_label = r'$n$')
+mej = LogUniform(1e-1, 100, 'mej', latex_label = r'$M_{\mathrm{ej}} [M_{\odot}]$')
+eps_b = LogUniform(1e-7, 1, 'eps_b', latex_label = r'$\epsilon_{\mathrm{B}}$')
+gamma_b = LogUniform(1e2, 1e7, 'gamma_b', latex_label = r'$\gamma_{\mathrm{b}}$')

redback/priors/shocked_cocoon.prior

@@ -1,8 +1,8 @@
 redshift = Uniform(1e-3,3,name='redshift', latex_label = r'$z$')
-mej = Uniform(1e-4, 0.1, 'mej', latex_label = r'$M_{\mathrm{ej} }~(M_\odot)$')
-vej = Uniform(0.1, 0.7, 'vej', latex_label = r'$v_{\mathrm{ej}}~(c)$')
+mej = Uniform(1e-4, 0.2, 'mej', latex_label = r'$M_{\mathrm{ej} }~(M_\odot)$')
+vej = Uniform(0.01, 0.7, 'vej', latex_label = r'$v_{\mathrm{ej}}~(c)$')
 eta = Uniform(1, 5, '\\eta', latex_label = r'$\\eta$')
-tshock = Uniform(1, 2, 'tshock', latex_label = r'$t_{\mathrm{shock}}~(\mathrm{s})$')
-shocked_fraction = Uniform(0.1, 1, 'shocked_fraction', latex_label = r'$f_{\mathrm{shocked}}$')
-cos_theta_cocoon = Uniform(0.2, 0.9, 'cos_theta_cocoon', latex_label = r'$\cos~\\theta_{\mathrm{cocoon}}$')
-kappa = Uniform(1, 30, 'kappa', latex_label = r'$\\kappa~(\mathrm{cm}^{2}/\mathrm{g})$')
+tshock = Uniform(0.1, 10, 'tshock', latex_label = r'$t_{\mathrm{shock}}~(\mathrm{s})$')
+shocked_fraction = Uniform(0.01, 1, 'shocked_fraction', latex_label = r'$f_{\mathrm{shocked}}$')
+cos_theta_cocoon = Uniform(0.866, 1.0, 'cos_theta_cocoon', latex_label = r'$\cos~\\theta_{\mathrm{cocoon}}$')
+kappa = Uniform(0.1, 30, 'kappa', latex_label = r'$\\kappa~(\mathrm{cm}^{2}/\mathrm{g})$')

redback/priors/sn_fallback.prior

@@ -0,0 +1,8 @@
+redshift = Uniform(1e-3,3,name='redshift', latex_label = r'$z$')
+logl1 = Uniform(51, 57, name='logl1', latex_label=r'$\log_{10}L_{1} [erg~s^{-1}]$')
+tr = LogUniform(1e-4, 100, name='tr', latex_label=r'T_{r} [day]')
+mej = LogUniform(1e-4, 100, 'mej', latex_label = r'$M_{\mathrm{ej}}~(M_\odot)$')
+vej = LogUniform(1e3, 1e5, 'vej', latex_label = r'$v_{\mathrm{ej}}~(\mathrm{km}/\mathrm{s})$')
+kappa = Uniform(0.05, 2, 'kappa', latex_label = r'$\\kappa~(\mathrm{cm}^{2}/\mathrm{g})$')
+kappa_gamma = LogUniform(1e-4, 1e4, 'kappa_gamma', latex_label = r'$\\kappa_{\\gamma}~(\mathrm{cm}^{2}/\mathrm{g})$')
+temperature_floor = LogUniform(1e3,1e5,name = 'temperature_floor', latex_label = r'$T_{\mathrm{floor}}~(\mathrm{K})$')

redback/priors/stream_stream_tde.prior

@@ -0,0 +1,10 @@
+redshift = Uniform(1e-6, 3, 'redshift', latex_label = r'$z$')
+peak_time = LogUniform(0.1,60, name='peak_time', latex_label = r'$t_{\mathrm{peak}}~(\mathrm{day})$')
+sigma_t = LogUniform(10,60, name='sigma_t', latex_label = r'$\\sigma~(\mathrm{day})$')
+mbh_6 = LogUniform(0.01, 20, name='mbh_6', latex_label = r'$M_{\mathrm{BH}}~(10^{6}~M_\odot)$')
+mstar = LogUniform(0.1, 10, name='stellar_mass', latex_label = r'$M_{\mathrm{star}}~(M_\odot)$')
+c1 = 1.0
+del_omega = 2.0
+f = 0.2
+h_r = 0.2
+inc_tcool = 1

redback/priors/stream_stream_tde_bolometric.prior

@@ -0,0 +1,9 @@
+peak_time = LogUniform(0.1,60, name='peak_time', latex_label = r'$t_{\mathrm{peak}}~(\mathrm{day})$')
+sigma_t = LogUniform(10,60, name='sigma_t', latex_label = r'$\\sigma~(\mathrm{day})$')
+mbh_6 = LogUniform(0.01, 20, name='mbh_6', latex_label = r'$M_{\mathrm{BH}}~(10^{6}~M_\odot)$')
+mstar = LogUniform(0.1, 10, name='stellar_mass', latex_label = r'$M_{\mathrm{star}}~(M_\odot)$')
+c1 = 1.0
+del_omega = 2.0
+f = 0.2
+h_r = 0.2
+inc_tcool = 1

redback/priors/tde_fallback.prior

@@ -0,0 +1,9 @@
+redshift = Uniform(1e-6, 3, 'redshift', latex_label = r'$z$')
+mbh6 = Uniform(0.01, 20, name='mbh_6', latex_label = r'$M_{\mathrm{BH}}~[10^{6}~M_{\odot}]$')
+mstar = Uniform(0.1, 30, name='mstar', latex_label = r'$M_{\mathrm{star}} [M_{\odot}]$')
+tvisc = LogUniform(1e-3, 1e2, name='tvisc', latex_label = r'$t_{\mathrm{visc}}$')
+bb = Uniform(0, 2, name='bb', latex_label = r'$\\beta^{\star}$')
+eta = LogUniform(1e-4, 0.4, name='eta', latex_label=r'$\eta$')
+leddlimit = 1
+rph0 = LogUniform(1e-4, 1e4, name='rph_0', latex_label = r'$R_{\mathrm{ph-0}}$')
+lphoto = Uniform(0, 2, name='lphoto', latex_label = r'$L_{\mathrm{photo}}^{\star}$')

redback/priors/tde_fallback_bolometric.prior

@@ -0,0 +1,6 @@
+mbh6 = Uniform(0.01, 20, name='mbh_6', latex_label = r'$M_{\mathrm{BH}}~[10^{6}~M_{\odot}]$')
+mstar = Uniform(0.1, 30, name='mstar', latex_label = r'$M_{\mathrm{star}} [M_{\odot}]$')
+tvisc = LogUniform(1e-3, 1e2, name='tvisc', latex_label = r'$t_{\mathrm{visc}}$')
+bb = Uniform(0, 2, name='bb', latex_label = r'$\\beta^{\star}$')
+eta = LogUniform(1e-4, 0.4, name='eta', latex_label=r'$\eta$')
+leddlimit = 1

redback/priors/tde_synchrotron.prior

@@ -0,0 +1,6 @@
+redshift = Uniform(0.01, 3, 'redshift', latex_label=r'$z$')
+Mej = Uniform(0.1, 10, 'Mej', latex_label = r'$M_{\mathrm{ej}}~(M_\odot)$')
+vej = Uniform(1e3, 3e4, 'vej', latex_label = r'$v_{\mathrm{ej}}~(\mathrm{km}/\mathrm{s})$')
+logepse = Uniform(-5, 0, 'logepse', latex_label=r'$\log_{10}~\\epsilon_{e}$')
+logepsb = Uniform(-5, 0, 'logepsb', latex_label=r'$\log_{10}~\\epsilon_{B}$')
+p = Uniform(2, 3, 'p', latex_label=r'$p$')

redback/priors/two_comp_kne_rosswog_heatingrate.prior

@@ -1,9 +1,9 @@
 redshift = Uniform(1e-6, 0.1, 'redshift', latex_label = r'$z$')
 mej_1 = Uniform(1e-2, 0.05, 'mej', latex_label = r'$M_{\mathrm{ej}~1}~(M_\odot)$')
 vej_1 = Uniform(0.05, 0.3, 'vej', latex_label = r'$v_{\mathrm{ej}~1}~(c)$')
-ye_1 = Uniform(0.05, 0.4, 'ye', latex_label = r'$Y_{e}~1$')
+ye_1 = Uniform(0.05, 0.5, 'ye', latex_label = r'$Y_{e~1}$')
 temperature_floor_1 = LogUniform(100, 6000, 'temperature_floor', latex_label = r'$T_{\mathrm{floor}~1}~(\mathrm{K})$')
 mej_2 = Uniform(1e-2, 0.05, 'mej', latex_label = r'$M_{\mathrm{ej}~2}~(M_\odot)$')
 vej_2 = Uniform(0.05, 0.3, 'vej', latex_label = r'$v_{\mathrm{ej}~2}~(c)$')
-ye_2 = Uniform(0.05, 0.4, 'ye', latex_label = r'$Y_{e}~2$')
+ye_2 = Uniform(0.05, 0.5, 'ye', latex_label = r'$Y_{e~2}$')
 temperature_floor_2 = LogUniform(100, 6000, 'temperature_floor', latex_label = r'$T_{\mathrm{floor}~2}~(\mathrm{K})$')

redback/priors/villar_sne.prior

@@ -0,0 +1,7 @@
+aa = LogUniform(1e-15,1e15,name='aa', latex_label = r'$A$')
+cc = LogUniform(1e-15,1e15,name='bb', latex_label = r'$C$')
+t0 = Uniform(0,50,name='t0', latex_label = r'$t_0$')
+tau_rise = Uniform(0.01, 50, name='tau_rise', latex_label = r'$\\tau_{\\mathrm{rise}}$')
+tau_fall = Uniform(1, 300, name='tau_fall', latex_label = r'$\\tau_{\\mathrm{fall}}$')
+gamma = Uniform(0.1, 100, name='gamma', latex_label = r'$\\gamma$')
+nu = Uniform(0, 1, name='nu', latex_label = r'$\\nu$')

redback/priors.py

@@ -20,7 +20,7 @@ def get_priors(model, times=None, y=None, yerr=None, dt=None, **kwargs):
     :param kwargs: Extra arguments to be passed to the prior function
     :return: priors: PriorDict object
     """
-    prompt_prior_functions = dict(gaussian=get_gaussian_priors, skew_gaussian=get_skew_gaussian_priors,
+    prompt_prior_functions = dict(gaussian_prompt=get_gaussian_priors, skew_gaussian=get_skew_gaussian_priors,
                                   skew_exponential=get_skew_exponential_priors, fred=get_fred_priors,
                                   fred_extended=get_fred_extended_priors)
 

redback/simulate_transients.py

@@ -18,7 +18,7 @@ class SimulateGenericTransient(object):
         """
         A generic interface to simulating transients
 
-        :param model: String corresponding to redback model
+        :param model: String corresponding to redback model or a python function that can evaluate an SED.
         :param parameters: Dictionary of parameters describing a single transient
         :param times: Time values that the model is evaluated from
         :param model_kwargs: Additional keyword arguments, must include all the keyword arguments required by the model.
@@ -35,10 +35,13 @@ class SimulateGenericTransient(object):
             Default is 'gaussianmodel' where sigma is noise_term * model.
             Another option is 'gaussian' i.e., a simple Gaussian noise with sigma = noise_term.
         :param noise_term: Float. Factor which is multiplied by the model flux/magnitude to give the sigma
-            or is sigma itself for 'gaussian' noise.
+            or is sigma itself for 'gaussian' noise. Or the SNR for 'SNRbased' noise.
         :param extra_scatter: Float. Sigma of normal added to output for additional scatter.
         """
-        self.model = redback.model_library.all_models_dict[model]
+        if model in redback.model_library.all_models_dict:
+            self.model = redback.model_library.all_models_dict[model]
+        else:
+            self.model = model 
         self.parameters = parameters
         self.all_times = times
         self.model_kwargs = model_kwargs
@@ -95,9 +98,13 @@ class SimulateGenericTransient(object):
             noise = np.random.normal(0, self.noise_term, len(true_output))
             output = true_output + noise
             output_error = self.noise_term
+        elif noise_type == 'SNRbased':
+            sigma = np.sqrt(true_output + np.min(true_output)/self.noise_term)
+            output_error = sigma
+            output = true_output + np.random.normal(0, sigma, len(true_output))
         else:
             logger.warning(f"noise_type {noise_type} not implemented.")
-            raise ValueError('noise_type must be either gaussianmodel or gaussian')
+            raise ValueError('noise_type must be either gaussianmodel, gaussian, or SNRBased')
 
         if extra_scatter > 0:
             extra_noise = np.random.normal(0, extra_scatter, len(true_output))