Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Update documentation for gravitational wave module #359

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Lucia-Fonseca
Copy link
Member

Description

This pull request updates the documentation for the gravitational wave module. It closes #357

Checklist

  • Follow the Contributor Guidelines
  • [ ] Write unit tests
  • Write documentation strings
  • Assign someone from your working team to review this pull request
  • Assign someone from the infrastructure team to review this pull request

@Lucia-Fonseca Lucia-Fonseca self-assigned this Oct 29, 2020
@Lucia-Fonseca Lucia-Fonseca added documentation Improvements or additions to documentation module: gravitational wave labels Oct 29, 2020
@Lucia-Fonseca Lucia-Fonseca marked this pull request as draft October 29, 2020 18:52
@Lucia-Fonseca Lucia-Fonseca requested a review from a team November 3, 2020 15:36
@Lucia-Fonseca Lucia-Fonseca marked this pull request as ready for review November 3, 2020 15:36
Copy link
Contributor

@rrjbca rrjbca left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Member Author

Lucia-Fonseca commented Nov 10, 2020

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.

@rrjbca
Copy link
Contributor

rrjbca commented Nov 11, 2020

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 rrjbca changed the base branch from master to main February 22, 2021 13:39
@Lucia-Fonseca Lucia-Fonseca changed the title Update documentation for gravitational wave module DOC: Update documentation for gravitational wave module May 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation module: gravitational wave
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Gravitational Wave documentation
2 participants