gyro-interp

Hi! Welcome to the documentation for gyrointerp, a Python package that calculates gyrochronal ages by interpolating between open cluster rotation sequences.

gyrointerp packages the model from Bouma, Palumbo & Hillenbrand (2023) into a fast and easy-to-use framework. The documentation below will walk you through the most common use-cases. For brevity, we’ll refer to that paper as BPH23.

This package is designed to meet the needs of working astronomers with interests in gyrochronal age measurement, and we encourage community involvement. If you find a bug or would like to request a feature, please do create an issue on Github.

Attribution:

The reference for both the software and method will be Bouma, Palumbo & Hillenbrand (2023). This manuscript is currently under review at the AAS journals; the submitted version is available at this link.

The references for the rotation period data upon which the code is based are as follows.

• α Per: Boyle & Bouma (2023)

• Pleiades: Rebull et al. (2016)

• Blanco-1: Gillen et al. (2020)

• Psc-Eri: Curtis et al. (2019a)

• NGC-3532: Fritzewski et al. (2022)

• Group-X: Messina et al. (2022)

• Praesepe: Rampalli et al. (2021)

• NGC-6811: Curtis et al. (2019b)

• NGC-6819: Meibom et al. (2015)

• Ruprecht-147 Curtis et al. (2020)

• M67: Barnes et al. (2016) and Dungee et al (2022).

User Guide:

Contents:

• Installation
• Examples
  • Gyrochronal age for one star
  • Gyrochronal ages for many stars
  • Visual interpolation for a star’s age
• Caveats
  • Stellar Evolution
  • Binarity
• Frequently asked questions
  • What happens for stars cooler than 3800 K?
  • What happens for stars younger than 80 Myr?
  • What happens for stars older than 2.6 Gyr?
• gyrointerp package
  • gyrointerp.gyro_posterior module
  • gyrointerp.models module
  • gyrointerp.getters module
  • gyrointerp.age_scale module
  • gyrointerp.extinctionpriors module
  • gyrointerp.helpers module
  • gyrointerp.plotting module
  • gyrointerp.teff module

Changelog:

0.3 (2023-03-03)

• Bugfix a ModuleNotFoundError for calls to gyrointerp.plotting

• Add “posterior stacker” and cross-validation drivers.

0.2 (2023-02-21)

• Initial software release to PyPI and github.

0.1 (2023-02-21)

• Initial software release to github.