DOC: Update documentation for gravitational wave module
Description
This pull request updates the documentation for the gravitational wave module. It closes #357
Checklist
- [x] Follow the Contributor Guidelines
- ~[ ] Write unit tests~
- [x] Write documentation strings
- [x] Assign someone from your working team to review this pull request
- [x] Assign someone from the infrastructure team to review this pull request
Agreed. Thank you for suggesting this.
What would be an appropriate scale value? @itrharrison do you have any suggestion?
Since the purpose here is to demonstrate
b_band_merger_rateI would simplify the rest of the config file and just sample luminosities usingskypy.utils.schechterand the appropriatescaleparameter.
Should be able to work it out from the source code for scheter_lf_magnitude and luminosity_from_absolute_magnitude probably something like luminosity_from_absolute_magnitude(m_star, 'Lsun_B') for some value e.g. m_star = -21 @ntessore have I got that right?