avitase / libgravix2 Goto Github PK

This notebook could be used to demonstrate the Python binding and the interaction with the API in general. However, the notebook itself should be thoroughly overhauled and good documentation inside the notebook should be added.

We already generate a coverage report of our C test suite but we don't do anything useful with this report. At least we should add a badge to the README.md.

Currently, the unit tests for the C-API and for the Python binding are dummies. We should strive for a test suite with tests that run fast but cover the entire surface of the library. In a sense, approval tests might do the job here rather than testing each and every function. This test suite should also include various combinations of possible static/compile-time configurations.

For building the images of our documentation we need LuaLaTeX and a few other packages that come with Ubuntu's texlive-full installation. Presumably, we don't use 99% of the packages that come with full installation and we should try to reduce the size of this dependency, for example by using a fainer-grained package requirement.

There are more educated ways to implement the integration step s.t. rounding errors cancel. See N. Higham, "The Accuracy of Floating Point Summation" (1993) for details.

The README should open with a catchy GIF showing the propagation of a missile. Ideally, the animation should show the symmetric nature of the integrator, perhaps by simultaneously propagating the missile forward and backward in time.

As soon as we have approval tests (#1) we should investigate performance bottlenecks and improve the implementation.

Currently, orb_period does an unnecessary heap allocation here:

This can be removed by passing a pointer to a stack variable into PlanetsHandle.

The Doxygen documentation needs proper formatting. In particular, the width of the page should be limited and images should be centered. Ideally, a solution should work without external dependencies.