Installation
git
git clone https://github.com/haakoan/SynthGrav
import synthgrav
pip
#To come
Basic usage
import synthgrav
#Set up signal
s = synthgrav.Signal(time=t,modes=modes,
polarisation=polarisation)
#t, modes, and polarisation are user inputs
s.generate_signal() #Generate the signal
#In this example, the signal s will contain the
#time and the two modes, hp and hc, in
#s.time,s.signal[0],s.signal[1]
#Plot one signal component
#(assuming pylab is imported as plt)
plt.plot(s.time,s.signal[0])
Tutorial
The notebook Getting_started.ipynb provides a SynthGrav tutorial.
Documentation
Signal Class
This section documents the Signal class, through which users can generate a gravitational wave signal from a set of modes. Main Signal Class
Mode Generation
Mode Generation provides details on the underlying machinery that generates individual modes to form the signal.
Built-in Modes
SynthGrav includes built-in modes for supernovae. Find details in Built-in Modes.
Contact
Haakon Andresen: haakon.andresen (at) astro.su.se
Bella Finkel: blfinkel (at) wisc.edu