danielandreasen/pyares

Configure, run, and read ARES from the comfort of python

pyARES

A package to run ARES, configure the input file, and read the output.

This require ARES to already be installed in your PATH.

Requirements

This was developed on python=3.6 and use f-strings, and is thus not compatible with versions lower than that. It also requires matplotlib, numpy, and pandas.

If you would like to run this on an earlier version, it is straight forward to fix it, however you should consider using python3 instead as it is only a matter of time before python2.7 is no longer supported.

Usage

Run ARES with some standard inputs

from ARES import ARES
config = {'specfits': 'path/to/fits',
          'readlinedat': 'path/to/linelist',
          'fileout': 'path/to/output'}
a = ARES(**config)   # Setup and run ARES
output = ARES.output # Return an ARESOutput object
rv = ARES.rv         # Get the RV as meausered by ARES

Run ARES from an input file

If you prefer to edit the mine.opt file by hand, that is possible as well.

from ARES import ARES

a = ARES.from_config('path/to/mine.opt')  # Does not have to be called mine.opt, but need same structure
output = a.output

Get RV and/or output from a previous run

If you have run ARES from another application, and you just want to analyse the results, you can do that as well!

from ARES import ARES

output = ARES.read_output('path/to/output')
rv = ARES.get_rv('path/to/log')

Be careful, the log file is overwritten everytime ARES is run on new. It is called logARES.txt and is the default value of ARES.get_rv.

Plotting with ARESOutput

# Run ARES and get the output object
a = ARES(**config)
output = ARES.output
plt.figure()
output.plot('EW')  # Plot EW against wavelength

plt.figure()
output.plot('EW', 'EWerr') # EWerr against EW
# plot method also takes standard matplotlib inputs
plt.show()

Comparing two outputs

o1 = ARES.read_output('path/to/output1')
o2 = ARES.read_output('path/to/output2')

# Percentage difference for amplitude between two outputs from ARES
p_diff = o1.percent_diff(o2, 'amplitude')

# Mean squared error (MSE) between two outputs from ARES
mse = o1.mse(o2, 'fwhm')

Columns available

These are the columns available from the ARES output:

• wavelength
• nlines
• depth
• fwhm
• EW
• EWerr
• amplitude
• sigma
• mean