Required Platform
=================

MCSMDP is developed under Ubuntu 8.10. However, because the code is
written in pure python, the software can work any operating system
supporting python, and other required supporting packages (e.g., other
Linux systems, Solaris, cygwin, and Mac OS X etc.,).

Thanks to pre-release users, it is reported that MCSMDP works under
following operating system:

- Ubuntu 8.10, 10.4
- CentOS 4
- Mac OS X

Required Supporting Packages
============================

Please install the supporting packages listed bellow, before you
install MCSMDP.

- Python (>2.4)
 - readline and _tkinter should be enabled in compile option.
 - Python 3.x is not supported.
- stsci_python (including PyRAF)
 - http://www.stsci.edu/resources/software_hardware/pyraf/stsci_python
 - supporting packages required to install PYRAF are also needed.
- ds9
 - http://hea-www.harvard.edu/RD/ds9/
 - ximtools is not supported.
- xpa
 - http://hea-www.harvard.edu/RD/ds9/
- RO Python Package
 - http://www.astro.washington.edu/users/rowen/ROPackage/Overview.html
 - you can install via easy_install as:
 sudo easy_install RO

You may need other development (e.g., *-dev) packages to install these
packages. Please use your package management system (e.g., aptitude,
yum, etc.,) to install them.

Following packages are also needed to analyze emission lines (fitting,
stacking, and displaying etc.,):

- matplotlib
-- http://matplotlib.sourceforge.net/
- scipy
-- http://www.scipy.org/
- ipython
-- http://ipython.scipy.org/moin/
- R, rpy
-- http://www.r-project.org/
-- http://rpy.sourceforge.net/

Installation
============

1. extract files

extract tar+gzip files at the directory where you prefer to install.

 $ tar xvfz MCSMDP_[version].tgz
 $ tar xvfz MDPDB.tgz

2. set environmental variables.

set the directory where installed MCSMDP to "MCSMDP", and add
${MCSMDP}/bin to "PATH". For example you add the scripts bellow to
your ~/.cshrc, if you use tcsh.:

 setenv MCSMDP ${HOME}/iraf/scripts/MCSMDP/
 setenv PATH   ${MCSMDP}/bin/:${PATH}

3. set up your loginuser.cl

set mcsmdp, mdpdb and tmp variable and register mcsmdp task, for
example:

 set  mcsmdp     =       "home$scripts/MCSMDP/"
 task $mcsmdp    =       "mcsmdp$pyraf/mcsmdp.cl"
 set  mdpdb      =       "home$scripts/MDPDB/"
 set  tmp	 = 	 "home$tmp/"
 keep

Getting Started
===============

launch MCSMDP:
 $ mcsmdp

cl-like pyraf shell is launched by this command, and then type mcsmdp
to load mcsmdp package.
 > mcsmdp

enjoy! (^_^/

mktemplate.sh generates template command file for execution.

1. edit configuration file
 > copy MCSMDP$doc/mktemplate.conf .
 > !vi mktemplate.conf

For example:
 ## parameters
 coordlist="mdpdb\$ohlist/list_NS_HK500"                # file name of OH list
 mdpfile="CDFN_MASK03.mdp"                              # mask design file
 prefix="HK500"                                         # prefix for resultant file ([prefix]_[mdpfile].fits)
 # calibration data for chip1
 bpm1="mdpdb\$bpm/nlbpm1_FF64r.fits"                    # bad pixel mask file
 flat1="../../ana_v00/FLAT/DomeFlatD3Eve1_HK500.fits"   # flat frame file, which can be made by mkdflat
 gdb1="dir_mcsred\$DATABASE/mcsdistcrr1_feb07.dbs"      # geomap database file for distortion correction, which is available from MCSRED
 gmp1="mcsdistcrr1_feb07.gmp"                           # geomap database name
 # calibration data for chip2
 bpm2="mdpdb\$bpm/nlbpm2_FF64r.fits"
 flat2="../../ana_v00/FLAT/DomeFlatD3Eve2_HK500.fits"
 gdb2="dir_mcsred\$DATABASE/mcsdistcrr2_feb07.dbs"
 gmp2="mcsdistcrr2_feb07.gmp"

2. execute mktemplate and save the result to your preferred file
 > mktemplate mktemplate.conf > log.py

enjoy! (^_^/

Attention to Kindly Users
=========================

Although this software is provided for use as is no warranty, it will
be greatly appreciated to include a note saying that your results were
obtained using the software MCSMDP, to refer the paper Yoshikawa,
T. et al. 2010 (ApJ, 718, 112).

In case of problems, questions or suggestions related to the software,
please contact me by e-mail (preferably in English or Japanese).:

tomohiro@cc.kyoto-su.ac.jp