sherlockpipe.tidal.run_tidal

sherlockpipe.tidal.run_tidal(object_dir, candidate, properties)

Compute the tidal locking time for a detected exoplanet candidate.

Reads search results and star parameters, then calculates the time required for the planet to become tidally locked using the formalism of Holman & Tremaine (2001).

Parameters

object_dirstr, optional

Absolute path to the object directory containing search results. Defaults to the current working directory if None.

candidateint, optional

Index of the candidate signal (1-based) from candidates.csv.

propertiesstr, optional

Path to a YAML properties file defining planet and star parameters.