API Reference

pygyre.read_model(file, format='auto')

Read stellar model data from a file.

Parameters
  • file (str) – The name of the file.

  • format (str, optional) – The format of the file.

Returns

Data read from the file. Array values are stored in table columns, and scalar values in the table meta attribute.

Return type

astropy.table.Table

Raises

ValueError – If format does not correspond to a recognized format.

Notes

Valid formats are ‘GSM’, ‘MESA’, ‘POLY’ or ‘auto’ (autodetect).

pygyre.read_output(file, format='auto')

Read GYRE output data from a file.

Parameters
  • file (str) – The name of the file.

  • format (str, optional) – The format of the file.

Returns

Data read from the file. Array values are stored in table columns, and scalar values in the table meta attribute.

Return type

astropy.table.Table

Raises

ValueError – If format does not correspond to a recognized format.

Notes

Valid formats are ‘HDF’, ‘TXT’ or ‘auto’ (autodetect).