Installation

WINGSPAN has been run on DEC VAX/VMS, DEC OpenVMS Alpha, SUN (Solaris), and SGI IRIX operating systems. The minimal requirement for running WINGSPAN is IDL (version 3.5.1 or higher). If you desire to include the FORTRAN model fitting program MFIT, your machine must also support FORTRAN 77 with an operating system on which IDL provides dynamic linking via CALL_EXTERNAL. If these computer requirements are not met by your machine, you can probably arrange to remotely run WINGSPAN (see section 1.3) on a computer located at the GROSSC. You will, in either case, need an X-windows terminal or windows capability on a PC.

The WINGSPAN/MFIT package is archived in the file wgsp_XX.tar.gz (or wgsp_XX.zip), where XX represents the version number. Copy these files to a directory in which you want to install the software, and unpack. This will create a directory tree, with the top level directory called wingspan. The file wingspan/idl_source/wing.pro (hereafter, wing.pro) controls the compilation and execution of the software, and contains several machine-dependent parameters that must be set after the initial installation. There are also some user options that are controlled from this file. You must edit the file to change the machine-dependent parameters and to add any options. Read the comments in this file, and make the appropriate changes for your system.

If you are going to install the MFIT package, you must create the MFIT shared object for IDL's CALL_EXTERNAL. We have provided the following sub-directories:

1. wingspan/setup_vms
2. wingspan/setup_sun
3. wingspan/setup_irix

Consult the README file in the appropriate directory for further instructions.

In general, do not alter any files in the WINGSPAN directories; rather, copy the files you wish to change to your own directory, and then redefine the path to the new file (in wing.pro) as appropriate.

It is not necessary to copy the file wingspan/idl_source/wing.pro, provided the machine-dependent entries are valid for your machine (directories and filenames). You could, for example, define a command ``WING'' that enters IDL and executes the default wing.pro. Copy the file to your area if you want to customize the directories, filenames, or any of the optional parameters. You must change the WINGSPAN default printer to point to your own preferred Postscript printer. Also, the print string for your machine must be supplied:

WING_PRINTER = `MY_PS_PRINTER'
WING_PRINT_COMMAND = `PRINT/DELETE/QUE=HENDRX' ; VMS

After you have some experience running WINGSPAN, you may wish to copy the file mfit_control.dat, modify it, and point the MFIT_CONTROL_DEF variable in wing.pro to the new version. There are several control variables in mfit_control.dat which directly control aspects of WINGSPAN and MFIT (see section 5.2).

A summary of the WINGSPAN/MFIT installation is listed below.

Installing WINGSPAN/MFIT for VMS (VAX/AXP):

1. Unpack the WINGSPAN/MFIT source code in a directory of your choice. This will create the root directory [...wingspan].
2. Edit [...wingspan.setup_vms]compile.com, and change the logical WING$PARENT at the top of the file to correspond to your disk and directory.
3. $@COMPILE
   You can ignore any compiler warnings.
4. $@LINK
   This will create the object library MFIT.OLB in the [...wingspan.setup_vms] directory and the shared object MFIT_SHARE.EXE in the directory above this one, which is root wingspan directory.
5. Edit [...wingspan.idl_source]wing.pro to enter machine dependent requirements and custom options.
6. Invoke the program by entering IDL from the directory [...wingspan.idl_source] and typing @wing.pro (or just @wing). You may wish to copy wing.pro to your own directory to customize WINGSPAN or to add user-defined IDL routines.

Installing WINGSPAN/MFIT for UNIX:

1. Unpack the WINGSPAN/MFIT source code in a directory of your choice. This will create the root directory wingspan. Make sure that these files have the correct letter cases:
   
   wingspan/idl_source/wgsp_cb.pro
   wingspan/setup_xxx/Makefile.xxx
   
   where xxx denotes your OS.
2. Create the MFIT shared object for IDL's CALL_EXTERNAL (MFIT_SHARE).
   Edit wingspan/setup_XXX/Makefile.XXX for your operating system to specify the locations of the fortran libraries for ld. Run the shell script wingspan/setup_XXX/INSTALL You may have to chmod 755 on INSTALL first.
   
   make_mfitshare compiles the MFIT fortran subroutines, and creates the shared object MFIT_SHARE. You may have to chmod 755 on make_mfitshare first. From wingspan/setup_XXX:
   $make_mfitshare
   
   Put the shared object in wingspan/idl_source. From wingspan/setup_XXX:
   $mv MFIT_SHARE ../idl_source
   
   Some operating systems require the environment variable LD_LIBRARY_PATH to point to the shared object. If you get an error similar to "Error loading shared object" when you run WINGSPAN, try defining the environment variable LD_LIBRARY_PATH to point to the object wingspan/idl_source/MFIT_SHARE. From the directory containing MFIT_SHARE, you can enter
   $setenv LD_LIBRARY_PATH $PWD
   
   NOTES ON UNSUPPORTED OPERATING SYSTEMS:
   If a setup directory does not exist for your OS, you should create a new directory wingspan/setup_xxx and copy the files from another UNIX setup directory. You will have to edit the INSTALL file and add FLAG for your OS to specify the entry points to the shared object (see the INSTALL file). Some compilers add trailing underscores to the entry points, some add leading underscores, etc. You will have to check what your compiler does. The easiest way is to edit INSTALL and run it to make the shared object, without ensuring that you have the entry point specification correct. After the shared object is created, examine the entry points with the command
   $nm MFIT_SHARE more
   
   Look for entry points such as M_LOC, BACK_LFIT, M_ROUND_BEG, etc. This will show the format of the entry points (they will have leading and/or trailing underscores, or no underscores). Then edit INSTALL to specify the correct format, and re-run INSTALL. This script modifies the calls to CALL_EXTERNAL in the WINGSPAN source code. You will not have to remake the shared object.
3. You may now delete the object files wingspan/setup_XXX/*.o However, if you think you may need to re-create the MFIT image (for example, to add a user defined photon model function), you should save the *.o files so that the majority of the MFIT routines will not have to be recompiled.
4. Edit wingspan/idl_source/wing.pro to enter machine dependent requirements and custom options.
5. Invoke the program by entering IDL from the directory wingspan/idl_source and typing @wing.pro (or just @wing) You may wish to copy wing.pro to your own directory to customize WINGSPAN or to add IDL routines.

BATSE Home Page Responsible Manager: Charles Meegan
Web Curator: Valerie Connaughton
Last Updated: November 8, 1996.