moble / PostNewtonian.jl

Orbital dynamics and waveforms for binary black-hole systems, in the post-Newtonian approximation
MIT License
11 stars 1 forks source link

Documentation issues #24

Open vijayvarma392 opened 1 year ago

vijayvarma392 commented 1 year ago

In this page: https://moble.github.io/PostNewtonian.jl/dev/internals/waveforms/#PostNewtonian.coorbital_waveform, the link "Waveforms" section of the manual. gives a File not found error.

image image
vijayvarma392 commented 1 year ago

On a similar note, in this page: https://moble.github.io/PostNewtonian.jl/dev/interface/high-level/#.-Compute-the-waveform, shouldn't h[1, :] correspond to the (2,-1) mode?

image
vijayvarma392 commented 1 year ago

This page https://moble.github.io/PostNewtonian.jl/dev/internals/dynamics/#Approximants says TaylorT4 and TaylorT5 are available, but I'm getting errors like:

image

Relatedly, it would be good to have the defaults for these parameters in the documentation:

image

For example, is an array format ok for the Rotor, or does it need to be a quaternionic object or some such?

vijayvarma392 commented 1 year ago

If this is int, how does one enter half integers like 3.5?

image

Also, do we want to make PN orders for phasing and spins available as separate options?

vijayvarma392 commented 1 year ago

I like that t=0 is set to the time where Omega=Omega_i, so that if Omega_1 < Omega_i, negative times correspond to earlier frequencies. But this should be noted in the docs of https://moble.github.io/PostNewtonian.jl/dev/internals/dynamics/

vijayvarma392 commented 1 year ago

For the returned variables in https://moble.github.io/PostNewtonian.jl/dev/internals/dynamics/, is it possible to add a _to_dict() option so that the variables can also be accessed by name in Python? I see a way to do that in Julia, but not in Python at the moment.

vijayvarma392 commented 1 year ago

The docs should also say what waveform convention we use...it looks like the old SpEC convention? Should we switch to the new one with the minus sign?