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.

User Guide:

Contents:

• Installation
• Examples
  • Rotation-based age for one star
  • Age for an older star
  • 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?
  • Are there movies?
• 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

Attribution:

The reference for both the software and method is Bouma, Palumbo & Hillenbrand (2023). The relevant bibtex entry is as follows.

@ARTICLE{2023ApJ...947L...3B,
       author = {{Bouma}, Luke G. and {Palumbo}, Elsa K. and {Hillenbrand}, Lynne A.},
        title = "{The Empirical Limits of Gyrochronology}",
      journal = {\apjl},
     keywords = {Stellar ages, Stellar rotation, Field stars, Bayesian statistics, 1581, 1629, 2103, 1900, Astrophysics - Solar and Stellar Astrophysics, Astrophysics - Instrumentation and Methods for Astrophysics},
         year = 2023,
        month = apr,
       volume = {947},
       number = {1},
          eid = {L3},
        pages = {L3},
          doi = {10.3847/2041-8213/acc589},
archivePrefix = {arXiv},
       eprint = {2303.08830},
 primaryClass = {astro-ph.SR},
       adsurl = {https://ui.adsabs.harvard.edu/abs/2023ApJ...947L...3B},
      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}

If your result is particularly dependent on the rotation data from any one cluster, we also encourage you to refer to the relevant study:

• α 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), Dungee et al (2022), and Gruner et al. (2023).

Changelog:

0.7 (2026-01-25)

• Update deprecated numpy 2.4 np.trapz calls.

0.6 (2024-08-27)

• Increase assumed gaussian scatter around mean at >1 Gyr to better fit Ruprecht-147 and M67. The rationale and impact are documented here.

0.5 (2024-07-17)

• Make helpers.get_summary_statistics agnostic to scipy version.

• Clarify setup.py dependencies

• Bugfix ReadTheDocs auto-documentation.

• Move requirements.txt to docs/requirements.txt.

0.4 (2024-05-30)

• Add bounds_error = '4gyrextrap' option for 2.6-4 Gyr extrapolation. The rationale for this update is documented at this google doc.

• Refactor helpers.get_summary_statistics for better numerical precision.

• Add Gruner+2023 M67 data.

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.