Ploonetide¶

This section provides a complete API reference for the Ploonetide package, including the main simulation interface, the ODE modules, and utility tools. Use this guide to explore all classes and functions available for scientific workflows.

Tidal Simulators¶

The core interface to run tidal interaction simulations.

Simulation Class¶

`Simulation`	Build and run a simulation.
`Variable`	Define a new variable for integration.

Tidal Simulation Class¶

TidalSimulation

This class defines a tidal simulation.

ODE Modules¶

These modules define the differential equations used to simulate star-planet and planet-moon tidal systems.

Star-Planet Tidal ODEs¶

solution_star_planet

Define the coupled differential equation for the system of EDOs.

Planet-Moon Tidal ODEs¶

solution_planet_moon

Coupled ODE system for the star--planet--moon tidal problem.

Physical and Orbital Functions¶

Functions to calculate physical and orbital properties

Function Utilities

`stellar_lifespan`	Calculate lifespan of a star.
`hill_radius`	Calculate the Hill radius of a secondary body.
`roche_radius_masses`	Calculate the Roche radius of a secondary body orbiting a primary body.
`omegaAngular`	Rotational rate given the period.
`luminosity`

Utility Tools¶

Helpful plotting tools, colormaps, and numerical functions.

`dict2obj`	Converts dictionary to object
`make_rgb_colormap`	Return a LinearSegmentedColormap seq: a sequence of floats and RGB-tuples.
`colorline`	Plot a colored line with coordinates x and y.
`make_segments`	Create list of line segments from x and y coordinates, in the correct format for LineCollection: an array of the form numlines x (points per line) x 2 (x and y) array
`canonic_units`	Convert to chosen canonical units.