skypy icon indicating copy to clipboard operation
skypy copied to clipboard

DOC: Update documentation for gravitational wave module

Open Lucia-Fonseca opened this issue 4 years ago • 2 comments

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

Lucia-Fonseca avatar Oct 29 '20 18:10 Lucia-Fonseca

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_rate I would simplify the rest of the config file and just sample luminosities using skypy.utils.schechter and the appropriate scale parameter.

Lucia-Fonseca avatar Nov 10 '20 14:11 Lucia-Fonseca

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?

rrjbca avatar Nov 11 '20 09:11 rrjbca