Getting Started

IMPORTANT: These instructions are for GYRE version 2.0 and later. Instructions for version 1.x can be found here.


Prerequisites

To install GYRE you'll first need to ensure that the following packages are available on your system:

  • The MESA SDK software development kit plus its own prerequisites

Downloading & Unpacking the Source Code

Download the tarball containing the latest version of GYRE, and unpack it using the tar command. The example here will unpack version 3.0 of the code into your home directory:

cd ~/
tar xvf gyre-3.0.tar.gz

This places everything inside a new directory, ~/gyre. Of course, it's possible to unpack the code anywhere you want; all that matters is you remember where it is. A helpful way of doing this is to store the full path to the GYRE directory in an enviornment variable; for example,

export GYRE_DIR=~/gyre

if you're using the Bourne shell, or

setenv GYRE_DIR ~/gyre

if you're using the C shell. To avoid having to do this each time after logging in, these commands can be added to the ~/.profile (Bourne shell) and/or ~/.cshrc (C shell) files.

With GYRE_DIR set in this way, the top-level GYRE directory can be referenced in shell commands as $GYRE_DIR. The examples in the following discussion (and elsewhere on this Wiki) make extensive use of this shorthand.

Updating the Source Code

If at a later time you want to update GYRE to a more-recent release, it's simplest to delete $GYRE_DIR and then repeat the steps above.

Compiling the Source Code

To compile the source code, change into $GYRE_DIR and build using the make tool:

cd $GYRE_DIR
make

To speed up the build process, you may wish to add the -jN flag to make, where N is the number of cores on your system. Although some warning messages may be printed out during compilation, these can safely be ignored. A successful build will produce the following executables in the $GYRE_DIR/bin subdirectory:

  • gyre_ad : the adiabatic oscillation code
  • gyre_nad : the non-adiabatic oscillation code

Testing the Executables

To check that the GYRE executables have compiled correctly and give reasonable results, change into $GYRE_DIR and run tests using the make tool:

cd $GYRE_DIR
make test

The output from the tests should look something like this:

TEST homogeneous compressible model (analytic structure) ...succeeded
TEST homogeneous compressible model (polytropic structure) ...succeeded
⋮

If any of the tests fail, then you should submit a bug report in the GYRE forums. Otherwise, if things look good, then it's time to proceed to the Running GYRE page.

Updated

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.