IGRINS‐2: How to install - igrins/plp GitHub Wiki

Python requirements

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

The Pipeline 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 IGRINS-2 Pipeline

Both the IGRINS and IGRINS-2 pipeline releases are done on this git repo. All IGRINS-2 releases have the suffix IGRINS-2. You can find the and download the latest tarballed release here: https://github.com/igrins/plp/releases

You can also install the Pipeline by running "git clone" and clone the igrins2 branch:

git clone -b igrins2 https://github.com/igrins/plp.git

Paths used by the Pipeline

The Pipeline 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.