orlox / SideKicks.jl

Statistical Inference to DEtermine KICKS on compact objects
GNU General Public License v3.0
2 stars 0 forks source link

Documentation and cleanup #15

Closed reinhold-willcox closed 2 months ago

reinhold-willcox commented 2 months ago

General cleanup of the source code, primarily in the Orbits.jl file.

Generally added documentation headers for nearly all functions and other objects, though some of these still have remaining TODOs attached to them if I didn't know much about the object.

Unit tests cleaned up in runtests.jl. There is one still failing because the circular orbit and generalized orbit functions do not agree when the inputs are identical. This will require digging into the math of the generalized orbit function.