Preliminaries

Intended Audience

This manual is aimed at a broad audience — whether you’re a GYRE novice or a seasoned veteran, it provides you with the information you’ll need to get the most out of GYRE. However, it does presume some experience with Unix command-line environments, and likewise some basic familiarity with the subject of stellar oscillations. If you need the former, then the Internet is your oyster; and for the latter, we recommend the following online resources:

Obtaining GYRE

The source code for GYRE is hosted in the rhdtownsend/gyre git repository on GitHub. GYRE is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3.

Citing GYRE

If you use GYRE in your research, please cite the relevant ‘instrument’ papers:

  • Townsend & Teitler (2013) describes the basic operation of the code;
  • Townsend et al. (2018) outlines improvements to allow non-adiabatic calculations.
  • Goldstein & Townsend (2020, in press) describes the contour method for non-adiabatic calculations.

If you find yourself using GYRE on a regular basis, you might consider contributing to the project to ensure its long-term success. Options include

  • Contribute code to the project (e.g., via GitHub pull requests), to extend GYRE’s capabilities
  • Contribute documentation and tutorials to the project, to make GYRE more user-friendly
  • Invite the GYRE team to be co-authors on relevant papers
  • Invite the GYRE team to be co-investigators on relevant grant applications

Acknowledgements

GYRE has been developed with financial support from the following grants:

  • NSF awards AST-0908688, AST-0904607, ACI-1339606, ACI-1663696, and AST-1716436;
  • NASA awards NNX14AB55G, NNX16AB97G, and 80NSSC20K0515.

GYRE has also benefitted greatly from contributions (code, bug reports, feature requests) from the academic community.