Skip to content

How to Install

Jump to bottom Edit New page
kfkaplan edited this page May 21, 2024 · 13 revisions

Python requirements

We highly recommend using Anaconda (https://anaconda.org) and the channel conda-forge for managing python and packages. For running the PLP, you can create a seperate conda enviroment but it is not a requirement.

The PLP runs in Linux or MacOS, but but might be installable in Windows (let us know if you get it running). Install the latest version of python 3 and the latest version of the python dependencies below.

The PLP has the following python dependencies:

After installing Anaconda, below is an example of the commands you want to type into the terminal to create the a python environment (here called igrins-plp-env), install the various python dependencies

conda create --name igrins-plp-env --channel=conda-forge
conda activate igrins-plp-env
conda install numpy
conda install scipy
conda install astropy
conda install matplotlib
conda install pandas
conda install simplejson
conda install astroscrappy

Install the PLP

To install the PLP, you can run "git clone" to clone master branch:

git clone https://github.com/igrins/plp.git

or download the most recent tarball of the PLP from the releases page.

Paths used by the PLP

The PLP uses various directories to store files. The default paths for these directories are stored in the file recipe.config as follows

[DEFAULT]
MASTER_CAL_DIR=master_calib
INDATA_PATH=indata/%(UTDATE)s
OUTDATA_PATH=outdata/%(UTDATE)s
PRIMARY_CALIB_PATH=calib/primary/%(UTDATE)s
SECONDARY_CALIB_PATH=calib/secondary/%(UTDATE)s
QA_PATH=%(OUTDATA_PATH)s/qa
HTML_PATH=html/%(UTDATE)s
RECIPE_LOG_PATH=recipe_logs/%(UTDATE)s.recipes

Typically these paths are left unchanged, but they can be modified. The paths the user might be interested in modifying are:

  • recipe_logs - Where the files that tell the PLP how to reduce a night are stored
  • indata - Where the raw data are stored
  • outdata - Where the reduced data are stored
  • calib/primary - Where various intermediate calibration data products are stored such as wavelength solutions, order maps, etc.

Instead of modifying recipes.config the user can also use symbolic links to point to where data are stored. See https://kb.iu.edu/d/abbe for how to create symbolic links.

Every night of IGRINS data is given a $UTDATE in the format YYYYMMDD. So if you took data on March 23, 2020, it would have the UTDATE of 20200323. These are used in the indata, outdata, and calib paths.

Put the raw data in the right place

Now you need to give the PLP access to your IGRINS raw data. The "indata" directory should contain or point to the directory where the rawdata is organized by its UT date.

For example, "indata/20140525" should contain data taken in 2014-05-25.

Now go into the PLP directory

cd PLP

> ls indata/20140525
IGRINS_DT_Log_20140525-1_H.txt  SDCH_20140525_0083.fits
IGRINS_DT_Log_20140525-1_K.txt   SDCK_20140525_0001.fits
IGRINS_DT_Log_20140526-1_H.txt   SDCK_20140525_0002.fits
IGRINS_DT_Log_20140526-1_K.txt   SDCK_20140525_0003.fits
SDCH_20140525_0001.fits          SDCK_20140525_0004.fits
SDCH_20140525_0002.fits          SDCK_20140525_0005.fits
SDCH_20140525_0003.fits          SDCK_20140525_0006.fits
...

Everything installed and raw data in the right place? Next go to how to prepare recipe logs

Add a custom footer
Add a custom sidebar
Clone this wiki locally