Add documentation describing parameters in conversion.py

[bilby-bot]

In GitLab by @git.ligo:avi.vajpeyi on Dec 15, 2020, 11:00

Some function parameters (eg see https://lscsoft.docs.ligo.org/bilby/conversion.html#bilby.gw.conversion.generate_component_spins) dont have comments describing them. It would be helpful if they have some notes on what they are.

Table E1 would be a good starting point to write the definitions (https://dcc.ligo.org/DocDB/0168/P2000168/002/BilbyGWTC.pdf)

[bilby-bot]

In GitLab by @git.ligo:avi.vajpeyi on Dec 15, 2020, 11:07

It appears that transform_precessing_spins has some comments on the definitions of the parameters. I wonder why this function isn't showing up in the docs?

[bilby-bot]

In GitLab by @git.ligo:colm.talbot on Mar 25, 2021, 03:05

I suspect this is an issue with the decorator. I noticed some strange behaviour with other decorated functions/methods. I would be in favour of removing the decorator, numpy.vectorize is pretty useless and leads to floats being converted to arrays.

[bilby-bot]

In GitLab by @git.ligo:mattia.emma on Feb 22, 2024, 16:51

created branch 553-add-documentation-describing-parameters-in-conversion-py to address this issue

[bilby-bot]

In GitLab by @git.ligo:mattia.emma on Feb 22, 2024, 21:57

@git.ligo:colm.talbot I was referring to this comment. But maybe you meant the numpy.vectorize in the function transform_precessing_spins?

[bilby-bot]

In GitLab by @git.ligo:michael.williams on Oct 3, 2024, 17:55

unassigned @git.ligo:mattia.emma