Updating tutorial notebooks

approved this merge request

unapproved this merge request

@isobel.romero-shaw , this looks great. We should get this merged in soon, but we realised you've added some data to the tutorials directory that I don't think are needed (it should just be able to find those data files from elsewhere). Do you have 5 mins later on to chat about this?

Yep, sure! Any time this afternoon is fine for me.

Would it be possible to add some comment strings into the code blocks just to be explicit about what each line (or combination of lines) is doing? For example, in compare_samplers.ipynb, you could change:

time_duration = 1.
sampling_frequency = 4096.

injection_parameters = dict(mass_1=36., mass_2=29., a_1=0, a_2=0, tilt_1=0, tilt_2=0, phi_12=0, phi_jl=0,
                            luminosity_distance=100., iota=0.4, phase=1.3, waveform_approximant='IMRPhenomPv2',
                            reference_frequency=50., ra=1.375, dec=-1.2108, geocent_time=1126259642.413,
                            psi=2.659)

waveform_generator = bilby.gw.waveform_generator.WaveformGenerator(
    sampling_frequency=sampling_frequency,
    time_duration=time_duration,
    frequency_domain_source_model=bilby.gw.source.lal_binary_black_hole,
    parameters=injection_parameters)

hf_signal = waveform_generator.frequency_domain_strain()

to

time_duration = 1.          # set the signal duration in seconds
sampling_frequency = 4096.  # set the data sampling frequency (Hz)

injection_parameters = dict(mass_1=36.,   # source frame (non-redshifted) primary mass (solar masses)
                            mass_2=29.,   # source frame (non-redshifted) secondary mass (solar masses)
                            a_1=0,        # primary dimensionless spin magnitude
                            a_2=0,        # secondary dimensionless spin magnitude
                            tilt_1=0,     # polar angle between primary spin and the orbital angular momentum (radians)
                            tilt_2=0,     # polar angle between secondary spin and the orbital angular momentum (radians)
                            phi_12=0,     # azimuthal angle between primary and secondary spin (radians)
                            phi_jl=0,     # azimuthal angle between total angular momentum and orbital angular momentum (radians)
                            luminosity_distance=100.,  # luminosity distance to source (Mpc)
                            iota=0.4,     # inclination angle between line of sight and orbital angular momentum (radians)
                            phase=1.3,    # phase (radians)
                            waveform_approximant='IMRPhenomPv2',  # waveform approximant name
                            reference_frequency=50.,  # gravitational waveform reference frequency (Hz)
                            ra=1.375,     # source right ascension (radians)
                            dec=-1.2108,  # source declination (radians)
                            geocent_time=1126259642.413,  # reference time at geocentre (time of coalescence or peak amplitude) (GPS seconds)
                            psi=2.659     # gravitational wave polarisation angle
                            )

# initialise the waveform generator
waveform_generator = bilby.gw.waveform_generator.WaveformGenerator(
    sampling_frequency=sampling_frequency,
    time_duration=time_duration,
    frequency_domain_source_model=bilby.gw.source.lal_binary_black_hole,
    parameters=injection_parameters)

# generate a frequency domain waveform
hf_signal = waveform_generator.frequency_domain_strain()

Sure. For a notebook example I believe we should have as much explanation as possible. Thank you very much for your example. I'll make these changes today too.