Skip to content
This repository was archived by the owner on Aug 28, 2024. It is now read-only.

Commit

Permalink
Fixed linking issues
Browse files Browse the repository at this point in the history
  • Loading branch information
anand43 committed Mar 1, 2024
1 parent 1960295 commit d320174
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions docs/user-guide/gravitational-harmonics/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,16 @@ Gravitational Harmonics
##########################

Here, we show how to use Swiftest's Gravitational Harmonics capabilities.
Swiftest uses `SHTOOLS <https://shtools.github.io/SHTOOLS/>` to compute the gravitational harmonics coefficients for a given body and calculate it's associated acceleration kick.
Swiftest uses `SHTOOLS <https://shtools.github.io/SHTOOLS/>`__ to compute the gravitational harmonics coefficients for a given body and calculate it's associated acceleration kick.
The coefficients can be computed in a number of ways:
- Using the axes measurements of the body ( :func: `clm_from_ellipsoid <swiftest.shgrav.clm_from_ellipsoid>`)
- Using a surface relief grid ( :func: `clm_from_relief <swiftest.shgrav.clm_from_relief>`).

- Using the axes measurements of the body ( :func:`clm_from_ellipsoid <swiftest.shgrav.clm_from_ellipsoid>`)

- Using a surface relief grid ( :func:`clm_from_relief <swiftest.shgrav.clm_from_relief>`).

* This function is still in development and may not work as expected.

- Manually entering the coefficients when adding the central body ( :func: `add_body <swiftest.Simulation.add_body>`)
- Manually entering the coefficients when adding the central body ( :func:`add_body <swiftest.Simulation.add_body>`)

This is based on ``/spherical_harmonics_cb`` in ``swiftest/examples``.

Expand Down

0 comments on commit d320174

Please sign in to comment.