A guide to downloading
the DEIMOS pipeline code



Announcing the release of v1.1.4 of the UCB DEEP2 DEIMOS spec2d pipeline!!!
Read the version release notes here.
For those interested in updating an existing version of the spec2d code, please follow the instructions for updating. For new users, please follow the instructions below to download the required SDSS and UCB code.

Reducing data from recent DEIMOS longslit masks requires the most recent version of the pipeline.  This code is considered beta as it has not been passed through extensive verification as previous releases were, but we do not anticipate any problems for non-longslit masks, as changes are minor.


(1) Begin by creating a directory in which all of the UCB and SDSS IDL code will be installed.
          mkdir cvs

(2) To use CVS, you will need to set an environment variable in your .cshrc or .baschrc file. Add the following line to your .cshrc file (if you are running C-shell):
          setenv CVS_RSH ssh
Or add to your .bashrc file (if you are running Borne-shell):
          CVS_RSH=ssh
Remember to source your shell-script or relogin afterwards to apply these changes.

(3) To obtain the most recent, stamped version of the UCB pipeline code (the spec2d package, version v1.1.4) download the following tarfile into your cvs directory: spec2d.v1_1_4.tar.gz (~5.4MB uncompressed/~1.6MB compressed). Unpack the tarfile using the following commands:
          gunzip   -vf   spec2d.v1_1_4.tar.gz
          tar   xvf   spec2d.v1_1_4.tar

This will unpack the spec2d package. The spec2d code should now be found in the ~/cvs/spec2d/pro directory, the linelists in the ~/cvs/spec2d/etc directory, and so forth.

The current working version of the code (the beta version) is also available in a tarball format, spec2d.beta.tar.gz . Follow the directions given in the preceeding paragraph to install this copy of the code. Note that this is a developmental version of the code and could contain bugs as we continue to work and improve the pipeline, though currently this code is stable.

(4) To download the most recent version of the idlutils (IDL utilities) package from Princeton, visit the IDLUTILS download website. Dowload the most recent stamped version of the IDLUTILS package into your main directory (~/cvs/). Unpack the tarball using the following command:
          tar   xvf   idlutils-v4_9_13.tar
where idlutils-v4_9_13.tar is the name of the tarball downloaded. At the time of the last edit of this website, version v4_9_13 was the most recent edition of the IDLUTILS code. If a more recent version has been released, download the most recent version accordingly. Unpacking this tarball will create a new subdirectory (idlutils-v4_9_13) in your main cvs directory. You may now remove the downloaded .tar file.
(5) To install the SDSS idlutils package completely, you will need to compile the associated C libraries. To do this, execute the following commands at the terminal prompt:
          setenv   IDLUTILS_DIR   ~/cvs/idlutils-v4_9_13/
                Make sure that the path in the above line agrees with the directory name in your main cvs directory.
          setenv   PATH   $IDLUTILS_DIR/bin:$PATH
          setenv   IDL_PATH   +$IDLUTILS_DIR/goddard/pro:$IDL_PATH
          setenv   IDL_PATH   +$IDLUTILS_DIR/pro:$IDL_PATH
          cd   $IDLUTILS_DIR
          evilmake   all
This should create a variety of library (.so) files in the directory ~/cvs/idlutils/lib/. Note that in these instructions, it has been assumed that you are using C-shell. For instructions in Bourne-shell, see the IDLUTILS website.

(6) Download the DEIMOS calibration data tarfile (~550MB), calib.tar from this link into the directory ~/cvs, and unpack it using the command:
          tar   xvf   calib.tar
This will create a subdirectory called "calib" inside your main CVS directory. Inside this directory will be a variety of DEIMOS calibration files; you can then delete calib.tar.

(7) To use the IDL routines, you will need a .idlenv file and a .idlstartup file, typically located in your home directory (~). These links contain an example .idlenv file and a very simple .idlstartup file. If you have an exisiting .idlstartup file, simply make sure that the Goddard IDL Astronomy Library setup code is called within.

(8) Inside your .idlenv file, you will need to make sure that the following UNIX environment variables are set appropriately for your installation (note that we use csh syntax here):

          #     directories defining locations of IDL code and associated files
          setenv   IDLUTILS_DIR   ~/cvs/idlutils-v4_9_13
                Make sure that the path in the above line agrees with the directory name in your main cvs directory.
          setenv   DEEP_DIR   ~/cvs
          setenv   IDLSPEC2D_DIR   ~/cvs/spec2d
          #     directory within which all raw data is contained
          setenv   DEIMOS_DATA   /home/DEIMOS/rawdata
          #     directory within which calibration files are contained
          setenv   CALIB_DATA   ~/cvs/calib

If you have installed the pipeline and idlutils code in nonstandard locations, the environment variable IDLUTILS_DIR should point to the location of your idlutils CVS directory, while DEEP_DIR and IDLSPEC2D_DIR should point to your spec2d CVS directory; etc..

The environment variable DEIMOS_DATA, in conjunction with the RAWDATADIR line in a plan file, specifies the location of the raw DEIMOS data you wish to reduce; that is, when the pipeline is run the code will look for the raw data in the location given by $DEIMOS_DATA/RAWDATADIR. Thus, for the DEIMOS_DATA directory given above and the RAWDATADIR specified in the example plan file, the spec2d code would search for all DEIMOS files in the directory "/home/DEIMOS/rawdata/2002sep10/". For more information regarding the plan file, refer to the spec2d primer.

Finally, the environment variable CALIB_DATA denotes the location of the DEIMOS calibration files. If you have not already downloaded these files, refer to step (5) above.
For the environment variables to actually be set, your .idlenv file will have to be processed before you run IDL. The easiest way to do this is to add a line to the .cshrc or .bashrc file located in your home directory:
          source   .idlenv

You have now installed the DEEP2 DEIMOS pipeline - congratulations! To update your copy of the IDLUTILS code (as improvements are made in the packages), you simply need to download the most recent tarball from the Princeton website and follow steps (4) and (5) again. To receive the most recent version of the spec2d code, simply repeat step (3) above. As changes to the spec2d code are made and tested, new versions of the software will be made available.




created by Michael Cooper
last updated 12nov03