INSTALLATION (Jun96)             dimsum             INSTALLATION (Jun96)



            DIMSUM: DEEP INFRARED MOSAICING SOFTWARE, UM...
              Release Notes and Installation Instructions



SUMMARY
The  DIMSUM  external package is used to produce accurate sky subtracted
images from dithered observations.  The  package  was  developed  by  P.
Eisenhardt  (prme@kromos.jpl.nasa.gov), M. Dickinson (med@stsci.edu), S.
A.  Standford,  and   J.   Ward   with   assistance   from   F.   Valdes 
(fvaldes@noao.edu).   This  user-contributed package is distributed with
minimal documentation and support.  Technical questions and  suggestions
may be sent to the above authors.


RELEASE INFORMATION

V2: October 11, 1999
    This  version  has a simple fix to a parameter confusion in calls to
    IMCOMBINE under V2.11.2.  The fix will work with V2.11.2 and earlier
    versions.

V2: November 6, 1997
    This  version has modifications to use the image extension specified
    by the imtype variable as the default extension.  This allows you to
    work with image types other than .imh in IRAF V2.11.

Problem Avisory
    
    From valdes Wed Oct 22 09:15:56 1997
    Date: Wed, 22 Oct 97 09:15:55 MST
    From: valdes (Frank Valdes)
    To: apps
    Subject: DIMSUM - Problem with .pl files in v2.11
    
    Q:   Can  you  offer  me  some advice?  We have recently upgraded to
    v2.11, and I am trying to get DIMSUM to work.  I keep  running  into
    problems  with  DIMSUM's  use  of  .pl files.  A dimsum script might
    create    a    file    called    "junk.pl",    and     then     call   
    'imarith("junk.pl","-",1,"junk.pl")',  and  finally  try  to  access 
    "junk.pl" again.  But  the  problem  is  that  imarith's  output  is
    actually  "junk.imh", and so the scripts cannot find the images they
    need.  Is there any easy way to work around this problem?
    
    A: Yes there is a problem when tasks using  the  same  output  image
    name  as  the  input  image name (as in the imarith example you gave
    for DIMSUM).  What happens is that a temporary file is  created  and
    in  the  process  of doing this the image type gets changed.  We are
    looking at how this can be avoided in the tasks.
    
    There is a simple workaround.  You must set the "imtype" variable to
    include  image  type inheritance.  This is done by adding ",inherit"
    to the image type.  For instance if you usually work with imh  files
    then
    
        cl> reset imtype="imh,inherit"
    
    You can set this in your login.cl or loginuser.cl.  Note that if you
    just do the reset at a cl prompt you must do a flpr to  restart  any
    tasks using the new imtype definition.

April 1997
    Use of an obsolete task was replaced by a comparable task.

February 1997
    A problem with computing the shifts is fixed.

June 1996
    This is the first official release through the NOAO/IRAF group.


INSTALLATION INSTRUCTIONS
Installation  of  this external package consists of obtaining the files,
creating a directory containing the package, compiling  the  executables
or  installing  precompiled executables, and defining the environment to
load and run the package.  The package may be installed for  a  site  or
as  a  personal  installation.  If you need help with these installation
instructions  contact  iraf@noao.edu  or  call  the  IRAF   HOTLINE   at 
520-318-8160.

[1-site]
    If  you  are  installing the package for site use then login as IRAF
    and edit the IRAF file defining the packages.
    
        $ set def irafhlib  # VMS example
        % cd $hlib          # UNIX example
    
    Define the environment variable dimsum to be  the  pathname  to  the
    dimsum root directory.  The '$' character must be escaped in the VMS
    pathname and UNIX pathnames must be terminated  with  a  '/'.   Edit
    extern.pkg to include the following.
    
        reset dimsum = usr\$1:[dimsum]      # VMS example
        reset dimsum = /local/dimsum/       # UNIX example
        task  dimsum.pkg = dimsum$dimsum.cl
    
    Near  the  end of the hlib$extern.pkg file, update the definition of
    helpdb so it includes the dimsum help database, copying  the  syntax
    already  used  in  the  string.   Add  this  line  before  the  line 
    containing a closing quote:
    
        ,dimsum$lib/helpdb.mip\

[1-personal]
    If you are installing the package for personal  use  define  a  host
    environment  variable  with  the pathname of the directory where the
    package will be located.  Note that Unix  pathnames  must  end  with
    '/'.  For example:
    
        % setenv dimsum /local/dimsum/
    
    In your login.cl or loginuser.cl file make the following definitions
    somewhere before the "keep" statement.
    
        reset dimsum = /local/dimsum/
        task  dimsum.pkg = dimsum$dimsum.cl
        printf ("reset helpdb=%s,dimsum$lib/helpdb.mip\nkeep\n",
            envget("helpdb")) | cl
        flpr

[2] Login into IRAF.  Create a directory to contain the  package  files.
    This directory should be outside the standard IRAF directory tree.
    
        cl> mkdir dimsum$
        cl> cd dimsum

[3] The  package is distributed as a tar archive for the sources and, as
    an optional convenience,  a  tar  archive  of  the  executables  for
    select  host  computers.  Note that IRAF includes a tar reader.  The
    tar file(s) are most commonly obtained via anonymous ftp.  Below  is
    an example from a Unix machine.
    
        cl> ftp iraf.noao.edu (140.252.1.1)
        login: anonymous
        password: [your email address]
        ftp> cd iraf/extern
        ftp> get dimsum.readme
        ftp> binary
        ftp> get dimsum.tar.Z
        ftp> get dimsum-bin.<arch>.Z
        ftp> quit
        cl> !uncompress dimsum.tar
        cl> !uncompress dimsum-bin.<arch>
    
    The  readme  file  contains  these  instructions.  The <arch> in the
    optional executable distribution is replaced by the standard  system
    identification for your computer (sparc, ssun, alpha, linux, etc.).
    
    Upon  request  the  tar file(s) may be otained on tape for a service
    charge.  In this case you would  mount  the  tape  and  specify  the
    device name in the next step.

[4] Extract the source files from the tar archive using 'rtar".
    
        cl> softools
        so> rtar -xrf <archive>  where <archive> is the host name of the
                                 archive file or the IRAF tape
                                 device for tape distributions.
        so> bye
    
    On  some  systems, an error message will appear ("Copy 'bin.generic'
    to './bin fails") which can be ignored.  Also on  VMS  systems,  the
    various  bin.'mach'  directories  created  by  rtar  can be deleted.
    UNIX sites should leave the symbolic link 'bin' in the package  root
    directory  pointing  to  'bin.generic'  but  can  delete  any of the
    bin.<arch> directories that won't be used.  If there  is  no  binary
    directory  for the system you are installing it will be created when
    the package is compiled later.
    
    If the binary executables have been obtained these are now extracted
    into  the  appropriate  bin.<arch>  directory.   If  the  bin.<arch> 
    directory does not exist you will have to first create it.
    
        # Example of sparc installation.
        cl> mkdir bin.sparc                         # Create if necessary
        cl> cd bin.sparc            
        cl> rtar -xrf ../dimsum-bin.sparc.Z
    
    The archive file(s)  can  be  deleted  once  the  package  has  been
    successfully installed or the tape device can be freed.

[5] For  a  source  installation  you  now  have  to  build  the package
    executable(s).  First you configure the package for  the  particular
    architecture.   To  check the architecture names you can look at the
    mkpkg file.
    
        cl> cd dimsum
        cl> mkpkg generic           # Set or create generic directory
        cl> mkpkg <arch>            # Substitute sparc, ssun, alpha, etc.
        cl> mkpkg -p dimsum         # Compile, link, and install the software
        cl> mkpkg generic           # Set package to generic (optional)
    
    This will change the bin link from bin.generic to  bin.<arch>.   The
    binary   directory  will  be  created  if  not  present.   Then  any 
    executables are compiled and and  moved  to  the  binary  directory.
    Check  for  errors.   If the executables are not moved to the binary
    directory then step [1] was  not  done  correctly.   The  last  step
    restores  the  package  to  a  generic  configuration.   This is not
    necessary if you will only have one architecture for the package.

This should complete the installation.  You can  now  load  the  package
and begin testing and use.
