################################# The GYRE Stellar Oscillation Code #################################

.. image:: https://img.shields.io/github/license/rhdtownsend/gyre :alt: GitHub :target: https://github.com/rhdtownsend/gyre/blob/master/COPYING .. image:: https://img.shields.io/github/v/release/rhdtownsend/gyre :alt: GitHub release (latest by date) :target: https://github.com/rhdtownsend/gyre/releases/latest .. image:: https://img.shields.io/github/issues/rhdtownsend/gyre :alt: GitHub issues :target: https://github.com/rhdtownsend/gyre/issues .. image:: https://img.shields.io/travis/com/rhdtownsend/gyre :alt: Travis (.com) :target: https://travis-ci.com/github/rhdtownsend/gyre .. image:: https://img.shields.io/readthedocs/gyre :alt: Read the Docs :target: https://gyre.readthedocs.io/en/stable

Overview

GYRE is a stellar oscillation code. Given an input stellar model, GYRE calculates the eigenfrequencies and eigenfunctions for the normal oscillation modes of the model. These data can be put to a variety of uses; the most common is to compare them against observed oscillation frequencies of a star, allowing constraints on the star's fundamental parameters (mass, radius, etc.) to be established |---| the discipline of asteroseismology.

Documentation

Full documentation for GYRE can be found at https://gyre.readthedocs.io/en/stable.

Citing

If you use GYRE in your research, please cite one or more of the relevant 'instrument' papers:

• Townsend & Teitler (2013) <https://ui.adsabs.harvard.edu/abs/2013MNRAS.435.3406T/abstract>__ describes the basic operation of the code;
• Townsend, Goldstein & Zweibel (2018) <https://ui.adsabs.harvard.edu/abs/2018MNRAS.475..879T/abstract>__ outlines improvements to allow non-adiabatic calculations.
• Goldstein & Townsend (2020) <https://ui.adsabs.harvard.edu/abs/2020ApJ...899..116G/abstract>__ describes the contour method for non-adiabatic calculations.
• Sun, Townsend & Guo (2023) <https://ui.adsabs.harvard.edu/abs/2023arXiv230106599S/abstract>__ introduces the gyre_tides frontend for evaluating tidal responses.

.. |---| unicode:: U+2014