2.2.2. INSTALLATION

next, previous Section / Table of Contents / Index The installation of BALSAC (version 2.16) on a Unix system requires some basic knowledge of Unix system management. The installing person must have root privileges and should know the local system administrator. The installation procedure includes six steps (plus step 0 for uninstalling version 1) described in the following where the commands enclosed in quotes "..." are meant to be interactive Unix (c shell type) commands. For convenience we assume that the archive file BALSAC2.tar.Z of the original package resides in subdirectory /user/BALSAC2 and the installing person is logged in as super user (root). Steps 0: In case you have BALSAC Versions 1.0, 2.0 installed in your system and want to delete it before installing the new version you have to delete the old executables, default help and initialization files as well as the manual files e.g. by "rm /usr/local/balsac/balsac.* /usr/local/balsac/tstcol.*" and remove the old script files by e.g. "rm /usr/local/bin/balsac /usr/local/bin/tstcol" Note that for this action you have to have Unix super user privileges. If the old version is not removed it will not be overwritten by the update and can be used further on but there is no obvious need for it since all input file formats are compatible between version 1.0 and 2.x. Steps 1: Go to subdirectory /user/BALSAC2, uncompress the archive file, and unpack all BALSAC files by "cd /user/BALSAC2" "uncompress BALSAC2.tar.Z" "tar -xvf BALSAC2.tar" This creates the BALSAC (version 2.16) system consisting of files readme.1st last messages and installation, balsac2.doc manual, *.f , *.c complete source code, Makefile system generating file balsac2.scr BALSAC (version 2.16) multi-user script tstcol2.scr TSTCOL (version 2.16) multi-user script *.1 Unix man(ual) files for interactive use balsac2.hlp on-line help file balsac2.ini standard color initialization file bwgraph.ini initialization file for gray scale plots baltit21.ps PostScript file of the manual title page and examples head.hp header file for installation on Hewlett-Packard Unix systems uscore internal file to assist source code creation XMPLS subdirectory containing example input files HTML subdirectory containing the full BALSAC manual in html format, see step 5a below. Step 2: Generate the BALSAC run files by "make sys" where sys denotes the Unix system with sys = aix for IBM RS/6000 systems, AIX 3.1 or later, = osf for DEC Alpha systems, OSF/1 V3.0 or later, = tru64 for Compaq Alpha systems, Tru64 Unix V4.0 or later, = sgi for Silicon Graphics, IRIX V5.3 or later, = hpux for HP 9000 systems, HPux V9.0 or later, = solaris1 for SUN sparc stations, OS 4.1.2/Solaris 1, = solaris2 for SUN sparc stations, OS 5.x/Solaris 2.x, = ultrix for DECstations, Ultrix 4.1 or later, = convex for Convex Cxxx systems, OS 8.0 or later, = linux for Linux based systems, Kernel 1.2.13, gcc 2.7.0, ELF This creates run files balsac2.exe, tstcol2.exe of the BALSAC system. Depending on the local system installation the X.11 Windows include file directory may have to be added in the C compile step of the makefile as cc -O -c -Iincludedir all.c where includedir denotes the valid directory name (edit the makefile appropriately). Further, the local X.11 Windows basic library may reside in a directory other than the default assumed in the makefile. This requires changes in the two Fortran compile and final link steps of the makefile reading e.g. f77 balsac2.f all_.o -o balsac2.exe localdir/libX11.a f77 tstcol2.f all_.o -o tstcol2.exe localdir/libX11.a where localdir denotes the full name of the directory containing the local X.11 Windows basic library (edit the makefile appropriately). If you are in doubt consult your system administrator for the local directory names. Note that Linux based systems with an incorrect make installation may yield an error message " make: *** [linux] Error 4" requiring to run the compile steps of the makefile manually. Steps 3: Create a BALSAC system directory owned by root but accessible to all users e.g. /usr/local/balsac, move the BALSAC system and default initialization files to that directory, and set appropriate file restrictions by "mkdir /usr/local/balsac" (needed only if the directory does not exist from a earlier version 1 installation). "mv *.exe balsac2.ini balsac2.hlp /usr/local/balsac" "chmod 755 /usr/local/balsac/*.*" Consult your system administrator for a meaningful directory name. Steps 4: Edit the two BALSAC run scripts, balsac2.scr, tstcol2.scr, by replacing in line set files=DIRECTORY the word DIRECTORY by the appropriate name of the BALSAC system directory (e.g. /usr/local/balsac as used above). Then move the BALSAC run scripts to the system directory that holds local software, e.g. /usr/local/bin, by "mv balsac2.scr /usr/local/bin/balsac" "mv tstcol2.scr /usr/local/bin/tstcol" and make the scripts executable by "chmod 755 /usr/local/bin/balsac" "chmod 755 /usr/local/bin/tstcol" Note that all potential BALSAC users must have the directory /usr/local/bin in their directory path. Step 5: Make the man(ual) files of the BALSAC system available by moving the appropriate files to the Unix manual directory, e.g. /usr/man/man1 (consult your system administrator for the local name of the directory), by "mv *.1 /usr/man/man1" Step 5a : (optional) You can install a local copy of the BALSAC manual in hypertext (html) format by moving all files of subdirectory HTML to a publically accessible WWW server. These files can be viewed with any WWW browser such as Mosaic or Netscape. The initial manual file is balm.0.html containing the Table of Contents while all other files balm.x.html refer to the various manual sections. In addition, file balpam.html gives a short overview and links to the BALSAC home pages. Step 6: Remove the source code and tar file by "make clean" . Make all files of the directory /user/BALSAC2 holding the BALSAC manual print files (balsac2.doc, baltit21.ps) and the examples directory XMPLS publicly available. NOTE that the source code and tar file should be kept only for backup purposes and NOT made publicly available. Distributing or modifying the source code or parts of it without informing the author is unfair and violates copyright laws! After steps 1-6 of the installation are completed successfully BALSAC is accessible for all users in a multi-user environment and can be run by different users at the same time. BALSAC will start up using default initialization and/or on-line help files (balsac2.ini, balsac2.hlp of the BALSAC system directory) unless the user redefines the file names, see Sec. 6.1. In the following we list the shell script balsac2.scr to illustrate the philosophy of multi-user application of BALSAC. ---- file balsac2.scr start ------------------------------------------------ #!/bin/csh -f # # Calling script for Unix distribution of BALSAC Version 2.16 # # Authors: F. Rammer , K. Hermann (FHI Berlin) , May 3, 1993 # Version 2 revision: K. Hermann (FHI Berlin) , June 14, 1995 # # Description: # # This script enables the general use of BALSAC Version 2.16 ((C) Copyright # K. Hermann 1991-2005) in a Unix multiuser environment. The calling # convention from any user directory is # # balsac [-options] [datafile] [initfile] [helpfile] # # as decribed in the BALSAC Version 2.16 Users Guide. All run files # (balsac2.exe, tstcol2.exe) and default parameter files (balsac2.ini, # balsac2.hlp) are assumed to reside in directory 'files', see below. This # script file should be stored in a generally available directory which is # included in the path of generally available directory which is included in # the path of all potential BALSAC users. # # If an initialization file 'balsac2.ini' and/or a help file 'balsac2.hlp' # exists in the directory from which balsac is called the program will # override its defaults files (in directory 'files'). Otherwise the default # files are used at startup of balsac. set files=/usr/global/balsac # directory in which to find # initial data-, init-, helpfile set inifile=balsac2.ini set hlpfile=balsac2.hlp unset inilink unset hlplink if (! -f $inifile) then # no ini file in calling directory, make a symbolic link to default ln -s $files/$inifile $inifile set inilink endif if (! -f $hlpfile) then # no help file in calling directory, make a symbolic link to default ln -s $files/$hlpfile $hlpfile set hlplink endif $files/balsac2.exe $1 $2 $3 $4 # remove previously defined soft links if ($?inilink) rm $inifile if ($?hlplink) rm $hlpfile exit ---- file balsac2.scr end -------------------------------------------------- next, previous Section / Table of Contents / Index