Instalation Video Tutorial

This video gives some orientation on the instalation of ARES. Although it shows the instalation of ARESv1 in Ubuntu, the installation of ARESv2 is very similar. A new video will be produced in the near future. If you have problems on installation feel free to contact me.

ARES Support page


This is a copy of the README file for the ARESv2 code.
This package can be found in http://www.astro.up.pt/~sousasag/ares/

If you got the ARES package from another place, please report to sousasag(-at-)astro.up.pt or go to http://www.astro.up.pt/~sousasag/ares/ to fill the form to download the latest version of this code.

The previous support page can be found in http://www.astro.up.pt/~sousasag/ares/suport_old.html

1-CONTENTS OF THE PACKAGE:

READMEThis file
ARES_v2.csource code of main ARES
areslib.hsource code of main ARES functions
aresplot.hsource code for ARES plots
filesio.hsource code for ARES input/output file
ngaussfdf.hsource code for Gaussian fitting - non linear least square fitting
rvcor.hsource code for the spectral radial velocity correction
sn_rejt_estimator.hsource code for the automatic sn and rejt determination
mine.optdefault ARES input parameter file
sun_harps_ganymede.fitstest spectra - spectrum from the Sun via Ganymede
linelist.datlinelist example for ARES
test.ares_oriexpected result for ARES for default parameters and test file
mine.opt_oria copy of the default ARES input parameter file
mine.opt_autorejt_autorvARES input parameters example for automatic rejt and automatic RV correction
mine.opt_rejt_dep_lambdaARES input parameters example for rejt dependent on wavelenght
lambda_rejt.optfile needed for the option on rejt dependent on wavelenght

The spectrum sun_harps_ganymede.fits is corrected from the radial velocity and is avaiable on: http://www.eso.org/sci/facilities/lasilla/instruments/harps/inst/monitoring/sun.html

2-SYSTEM REQUIREMENTS:


cfitsio CFITSIO http://heasarc.nasa.gov/fitsio/fitsio.html
gcc GNU Compiler Collection http://gcc.gnu.org/
gsl GNU Scientific Library http://www.gnu.org/software/gsl/
OpenMP Open Multi-Processing library http://openmp.org/wp/
plotutils The plotutils Package http://www.gnu.org/software/plotutils/
or gnuplot gnuplot library http://www.gnuplot.info/

(note that the new gsl v2. has intruduced changes that are not compatible with the previous versions). ARES runs with gsl v1.x, not v2.x

3-INSTALLATION:


The new code was tested in different linux machines, with different linux flavours, including debian based, such as UBUNTU and Linux Mint, and other flavours such as FEDORA, CENT OS. The code was also tested in Mac OS.

Everything should compile smoothly if you use the repository of your OS to install the required libraries. If you have installed the libraries manually, keep a note on the location of the libraries in your computer.

4-CODE COMPILATION:


With the libraries installed from the repositories:

gcc -o ARES ARES_v2.c -lcfitsio -lgsl -lgslcblas -lm -lgomp -fopenmp

If you have installed one library manually, an example for the case of CFITSIO, is the folloing:

gcc -o ARES ARES_v2.c -L/usr/local/cfitsio/lib/ -I/usr/local/cfitsio/include/ -lcfitsio -lgsl -lgslcblas -lm -lgomp -fopenmp

Note: -L and -I is the location of the libraries and the include files of the cfitsio package.

In case of having problems finding the libraries, you can add the path of the missing files (e.g. error while loading shared libraries: libgsl.so.0: cannot open shared object file: No such file or directory) to $LD_LIBRARY_PATH.

After the compilation is completed you can create a link into your favorite link directories (e.g. ~/bin) symbolic link directory.

>$ln -s compiledfile ~/bin/ARES (it is better to use the full paths of both files)

If you have the ~/bin/ in the $PATH system variable then you can run the program easily by typing:

>$ARES

Make sure that you have the 'mine.opt' file in the running directory.

4.1- ARES@MAC


You can check the previous installation help for MAC. I will update this section if problems are identified.

5- INPUT PARAMETERS 'mine.opt' FILE:



specfits: 1D fits spectrum for the analysis.
readlinedat: Line list for the analysis.
fileout: Output file for the results.
lambdai: Initial wavelength for the search of the lines.
lambdaf: Final wavelength for the search of the lines.
smoothder: Parameter for the calibration of the search of the lines. Noise smoother for the derivatives.
space: Interval in Angstrom for the computation for each line.
rejt: Parameter for the calibration of the continuum position.
lineresol: This parameter sets the line resolution of the input spectra. If the code finds two lines closer than the value set for this parameters, then we take the two lines as one line alone.
miniline: Weaker line strength to be printed in the output file.
plots_flag: Flag for the plots. 0-runs in batch, 1-shows the plots and stops for each line calculation.
rvmask: parameter for the automatic RV correction.


Detailed description:



To run the code it is necessary to have a file in the system running directory named 'mine.opt' that contains the input parameters with a specified format. The format of this file can be seen below. The input parameters required to run are the following:

specfits: is the location of the spectra in the FITS format. The header of this file must contain the CRVAL1 and CDELT1 keywords. The spectra should be reduced and calibrated in wavelength. It is supposed that the spectra should have a preliminary normalization to avoid abnormal features in the 1D spectra such the ones that can appear when using reduced echelle spectra.
readlinedat: is the location of the file that contains the lines to be measured. The format of this file is described in the help file that is supplied with the code. Each line of this file should indicate the wavelength position of each line to measure. We note that the code can crash if is trying to find lines in a spectral region not existent in the spectrum (e.g. a spectral gap).
fileout: the output file. The results for the identified lines are prompted in this file with the following order: the central line wavelength, the number of lines used to fit the local spectrum, the depth of the line to measure, the FWHM of the line, the EW of the line, and the three coefficients of the gaussian used to fit the line (depth, sigma, central position) respectively.
lambdai: initial wavelength of the interval to search the lines.
lambdaf: final wavelength of the interval to search the lines.
smoothder: value of the smooth \textit{boxcar} to use in the numerical derivatives. Value 1 implies no smoothing.
space: wavelength interval around the line where the computation will be conducted.
rejt: parameter required to calibrate the local continuum determination.
lineresol: minimum distance in Angstroms between lines in the spectra.
miniline: minimum EW value that will be prompted into the output file.
plots_flag: If this flag is set to 1, plots of the continuum determination and the fit of the line will be displayed, otherwise the code will run automatically without interruptions. The stop of the plots is available at any time passing to the auto run of the code, so that the user can check the measurements of the lines in the beginning of the line list.


New MUST KNOW features:

5.1. specfits

Here you can still provide a FITS 1D spectra, or alternatively you can provide an ASCII file. For this to work the data should be available in two distinct columns (wavelength and flux separated by spaces). Note that the wavelength still needs to be in units of Angstroms and this file should not contain any header.

5.2. rejt

you can still provide a value for the rejt with values ranging from [0-1[. If you provide a value greater than one it will assume that you are providing the S/N of the spectra and will compute the rejt parameters using the relation presented in the 2015 paper.

Alternatively you can tell ARES to compute the S/N and rejt. To better explain, nothing better than a practical example. For example setting:

rejt=3;5764,5766,6047,6052,6068,6076

This will tell ARES to evaluate the noise in three different spectral ranges, the first number (3) defines the number of ranges, and each next pair of numbers represent each wavelength region. To select these spectral regions the user should perform a careful eye inspection of the typical spectra in study, and look for spectral regions without the presence of strong lines, the ideal case will be without any lines at all. These three spectral regions given in this example are regions that have no lines, or at most very week lines, for solar-type stars, and therefore the user can take these as our recommendation.

An extra option is to have the rejt dependent on the wavelenght for this we should use the following option:

rejt=-2

Note that for this to work the file 'lambda_rejt.opt' should in the same directory. An example for this file is presented bellow.

5.3. rvmask

this is the only new parameters. If you don't provide this parameter in the input parameter file the code will not complain and will work as before assuming that the spectra is already corrected in RV.

You can tell ARES the velocity to be corrected. For example 25.5 Km/s:

rvmask='0,25.5'.

The '0' in this option is for ARES to understand that the user is providing radial velocity to be corrected. The ARES code will read the value and will adjust the wavelength of the spectra accordingly with the Doppler shift formula:

Alternatively you can provide a mask to be used by ARES to estimate the RV. For example:

rvmask='3,6021.8,6024.06,6027.06,6024.06,20'

The first number (3) is the total of lines for the mask, the last number (20) is a kind of a ``space'' parameter to select the width for the wavelength region to compute the CCF which is then centered on the wavelength provided in the second to last position.

6. FILE EXAMPLES

Example of a standard 'mini.opt' file:

-----------------------------
specfits='sun_harps_ganymede.fits'
readlinedat='linelist.dat'
fileout='test.ares'
lambdai=3600.
lambdaf=9000.
smoothder=4
space=3.0
rejt=0.995
lineresol=0.1
miniline=2
plots_flag=0
-----------------------------

Example of a 'mini.opt' file for RV autocorrection and rejt auto determination

-----------------------------
specfits='sun_harps_ganymede.fits'
readlinedat='linelist.dat'
fileout='test.ares'
lambdai=3600.
lambdaf=9000.
smoothder=4
space=3.0
rejt=3;5764,5766,6047,6053,6068,6076
lineresol=0.1
miniline=2
plots_flag=1
rvmask='3,6021.8,6024.06,6027.06,6024.06,20'
-----------------------------

Example of a 'mini.opt' file for rejt dependent on wavelenght

-----------------------------
specfits='sun_harps_ganymede.fits'
readlinedat='linelist.dat'
fileout='test.ares'
lambdai=3600.
lambdaf=9000.
smoothder=4
space=3.0
rejt=-2
lineresol=0.1
miniline=2
plots_flag=0
rvmask='3,6021.8,6024.06,6027.06,6024.06,20'
-----------------------------

Example of a file 'lambda_rejt.opt' for the rejt dependent on wavelenght

-----------------------------
4000.00 0.992
4500.00 0.992
5000.00 0.993
5500.00 0.993
6000.00 0.994
6500.00 0.995
7000.00 0.994
-----------------------------

Examples of a line list file:'linelist.dat'

Requirements for this file:

- The first and the second lines are ignored by the code, you can use these lines to include an header.
- For the rest of the lines the code only reads the 1st column, that should be the one for the position of the lines in Angstrons

example 1:


------------------------------------------------------
WL Excit loggf Elm_Ion lt
------- --------- ------- ------- ---
4000.01 2.83 -3.687 FeI 26.0
4007.27 2.76 -1.666 FeI 26.0
4010.18 3.64 -2.031 FeI 26.0
4014.27 3.02 -2.330 FeI 26.0
4080.88 3.65 -1.543 FeI 26.0
4114.94 3.37 -1.720 FeI 26.0
------------------------------------------------------

example 2:


------------------------------------------------------


4000.01 line1
4007.27 line2
4010.18 line3
4014.27 line4
4080.88 line5
4114.94 line6
------------------------------------------------------

7. OUTPUT RESULT ('test.ares_ori'):


------------------------------------------------------
4000.01 9 0.07521 0.09146 7.32166 1.82360 -0.07521 331.47570 4000.03
4007.27 2 0.77465 0.10233 84.37734 0.77426 -0.77465 264.79268 4007.27
4010.18 9 0.35146 0.08053 30.12733 1.03317 -0.35146 427.55094 4010.17
4014.27 4 0.50826 0.08525 46.11996 1.97861 -0.50826 381.53631 4014.27
4080.88 3 0.59394 0.09307 58.83871 1.14868 -0.59394 320.11297 4080.88
------------------------------------------------------

Output report:

1st column: Wavelength of the line.
2nd column: Number of lines fitted for the line result.
3rd column: The depth of the line.
4th column: FWHM of the line.
5th column: EW of the line.
6th column: error on the EW of the line.
7th-9th column: gaussians coefficients for the line fit (depth, sigma, center).

FAQ

Problems with GSL 2.0 new versions.

If you find a problem with compilation with the error mentioning:
In file included from ARES_v2.c:47:
areslib.h: In function ‘fitngauss’:
areslib.h:589: error: ‘gsl_multifit_fdfsolver’ has no member named ‘J’
The solution is to replace the file areslib.h by the one that you can download here

Warning in Fonts for plotutils (Ubuntu 12.04):

1. apt-get install xfs xfstt (Problem in grace resolved)

2. apt-get install t1-xfree86-nonfree ttf-xfree86-nonfree ttf-xfree86-nonfree-syriac xfonts-75dpi xfonts-100dpi

(May be we just need to install xfonts-75dpi and xfonts-100dpi only)

3. Then set the path:

xset +fp /usr/share/fonts/X11/75dpi/
xset +fp /usr/share/fonts/X11/100dpi/

TMCalc wont compile with make:


If you were one of the first to download the code you might get stuck when doing the make. Download it again, or erase the comment line 19 (which is commented with // instead of the standard and accepted in gcc with /* */).