README.md 2.4 KB
Newer Older
Monica Rainer's avatar
Monica Rainer committed
1
GOFIO DRS
Monica Rainer's avatar
Monica Rainer committed
2
Language: Python 2.7 (gofio directory) or Python 3.x (gofio3 directory), one subroutine in Fortran77
Monica Rainer's avatar
Monica Rainer committed
3

Monica Rainer's avatar
Monica Rainer committed
4
5
6
7
8
If you use this software, please reference the following paper:
Rainer M., et al., 2018, Proc.SPIE 10702, 1070266
"Introducing GOFIO: a DRS for the GIANO-B near-infrared spectrograph",
https://doi.org/10.1117/12.2312130 

Monica Rainer's avatar
Monica Rainer committed
9
Python packages with minimum version requirement:
Monica Rainer's avatar
Monica Rainer committed
10
11
12
13
14
 - AstroPy v1.3
 - ccdproc v1.2 (a sub-package of AstroPy)
 - NumPy v1.12
 - SciPy v0.19
 - watchdog v0.8.2
Monica Rainer's avatar
Monica Rainer committed
15
 - docopt v0.6.1
Monica Rainer's avatar
Monica Rainer committed
16
17
 - barycorrpy

Monica Rainer's avatar
Monica Rainer committed
18

19
20
21
22
23
24
Other requirements:
 - fortran77 compiler
 - libcfitsio library

Installation:
 - preserve the directory tree:
Monica Rainer's avatar
Monica Rainer committed
25
   gofio/ OR gofio3/
26
27
28
29
30
31
32
33
34
35
36
     __init__.py
     __version__.py
     gofioDRS.py
     drslib/
       __init__.py
       clean_db.py
       config.py
       darkframes.py
       db.py
       flatframes.py
       gofio.py
Monica Rainer's avatar
Monica Rainer committed
37
       gofio2ascii.py
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
       logger.py
       nodding.py
       rawfiles.py
       stare.py
       varie.py
       wlframes.py
     resources/
       GIANOB_MASKC.fits
       UNe_lines_GIANO_selected.txt
       UNe_observed_lines_GIANOB_18nov2016.txt
       badpix_mask.fits
       straight_giano_2D_v1_1.f
 - compile the fortran77 straight_giano_2D_v1_1.f file:
   gfortran -o straight_giano_2D straight_giano_2D_v1_1.f -lcfitsio
 - modify the configuration file drslib/config.py in order to set the
   right directory path for raw and reduced files (CONFIG['BASE_RAW']
   and CONFIG['BASE_RED_DIR'])
 - run "python gofioDRS.py -h" for help

Monica Rainer's avatar
Monica Rainer committed
57
58

Output:
59
60
61
62
63
64
65
66
67
68
69
70
 - intermediate: *_str.fits, 2D images with orders straightened
   and bad pixel removed
 - final output: *_ms1d.fits. The spectra are flat-fielded, extracted,
   calibrated, and the cosmic rays are removed.
   The echelle orders are not merged.
   The FITS table has 50 rows and 4 columns, and it stores each echelle
   order in a row. The columns are: the number of the echelle order
   (from 32 - the reddest - to 81 - the bluest), the wavelength in nanometers,
   the fluxes and the signal-to-noise ratios.
 - final output (optional): *_s1d.fits. The spectra are flat-fielded, extracted, 
   calibrated, and the cosmic rays are removed. The echelle orders are merged.
   The barycentric correction is applied. These are monodimensional spectra with
Monica Rainer's avatar
Monica Rainer committed
71
72
73
74
75
76
   constant step in wavelength.

The program gofio2ascii.py may be used to convert the outputs from FITS format
to ASCII files. It requires as input a text list with the filepaths of the
files to convert.