This file contains installation and release notes for CAPTools Version 2.0-Beta. CONTENTS --------- 1.0 INSTALLATION 1.1 Unpacking and installing the CAPTools distribution 1.2 CAPTools directory structure 1.3 Machine specific Installation - Silicon Graphics 1.4 Setting up the CAPTools Environment 1.5 Before using CAPTools 1.6 Obtaining and installing a licence string 2.0 RUNNING CAPTools 3.0 COMPILING AND RUNNING CAPTOOLS GENERATED CODE 3.1 CAPLib supported enviroments and machines 3.2 Compiling generated code - Basics 3.3 Running generated code - Basics 4.0 FUNCTIONALITY 5.0 REPORTING BUGS 6.0 CONTACT INFORMATION 1.0 INSTALLATION ---------------- 1.1 Unpacking and installing the Distribution --------------------------------------------- CAPTools is distributed as a gzipped tar file. Use the following commands to unpack and install the installation. In the follwing steps we assume you have ftp'd or downloaded the release distribution captools-sgi-1.2Beta-025.tar.gz. 1) Consider where you wish to place the CAPTools distribution. Example locations might be /usr/local or /opt or $HOME. 2) cd e.g. /usr/local 3) gunzip -c captools-sgi-2.0Beta-001.tar.gz | tar xvpf - This will unzip the gzipped tar CAPTools distribution into the current directory. The distribution is completely contained within a directory with the same basename as the distribution filename. 4) Perform any machine specific instructions, see section 1.3 below 5) Set up the CAPTools Environment, see section 1.4 6) Read section 1.5 7) Obtain a licence string and install it in the CAPTools directory structure, see section 1.6 below. 1.2 CAPTools directory structure -------------------------------- The CAPTools installation directory structure is: $(CAPHOME)/bin -- Contains utility scripts that are not machine dependent. $(CAPHOME)/bin/$(CAPTOOLMACH) -- Contains captools executable and other machine specific executables. $(CAPHOME)/lib -- Contains various data files and versions of CAPTools comms libraries $(CAPHOME)/examples -- Contains examples from manual $(CAPHOME)/manual -- Online user manual (not in this release) 1.3 Machine specific Installation - Silicon Graphics ---------------------------------------------------- CAPtools runs on the SGI using XView libraries (Originally CAPTools was developed on SUN hardware when you had no choice but to use XView based libraries). So, you will need to obtain the XView libraries before you can run CAPTools. You can get these from the CAPTools web site area at: http://captool.gre.ac.uk/captool-release/openwin-lib-sgi-3.2.tar.gz 1) Consider where you wish to place the Xview distribution. Example locations might be /usr/local or /opt or $HOME. Is is best to install the openwin-lib distribution in a seperate location to that of the main CAPTools distribution. 2) cd e.g. /usr/local 3) gunzip -c openwin-lib-sgi-3.2.tar.gz | tar xvpf - This will unzip the gzipped tar Xview distribution into the current directory. The distribution is completely contained within a directory with the same basename as the distribution filename. Make sure that all the XView fonts are installed on your system. By default the proportional lucida fonts are missing. CAPTools will use Helvetica if these fonts are not present but for best visual apperance it would be wise to install the optional fonts. If you type versions | fgrep Xoptfonts if the output has an "I" in front of the output line like: I x_eoe.sw.Xoptfonts 07/27/94 X11 Optional Fonts then the optional fonts are installed. CAPTools attempts to choose the a font with the correct size. However if you have problems getting a decent font, i.e. with correct size windows, you can use the -font option. There are a few command line arguments which control the font for various window objects such as lists, textpanes. These may be helpful in getting CAPTools to display text in a more readable format on SGI workstations. Type captool -help to get information on the command line arguments available. 1.4 Setting up the CAPTools Environment --------------------------------------- The environment variables CAPHOME, CAPTOOLMACH, OPENWINHOME and LD_LIBRARY_PATH must be configured befure you can run captools. You can use one of the supplied setup scripts to configure some of these automatically. However CAPHOME and OPENWINHOME must be set prior to calling the setup script. Make sure that the environment variable OPENWINHOME points to the installed openwin-lib top level. The usecaptool script mentioned below uses OPENWINHOME to set LD_LIBRARY_PATH so that the captools binary can find the XView libraries. If you use a C Shell (csh) then add the following to your .cshrc or .login file setenv CAPHOME e.g. /usr/local/captool setenv OPENWINHOME if ( -e $CAPHOME/bin/usecaptool.csh) then source $CAPHOME/bin/usecaptool.csh endif Or, if you use a Bourne (sh) or Korn shell (ksh) then add the following to to your .profile or .login file. CAPHOME= e.g. /usr/local/captool OPENWINHOME= export CAPHOME, OPEWINHOME if [ -f $CAPHOME/bin/usecaptool.sh ]; then . $CAPHOME/bin/usecaptool.sh fi 1.5 Before using CAPTools ------------------------- You should be aware of the copyright and licensing of CAPTools. CAPTools is not a public domain code. By using the CAPTools software you are agreeing to abide by the terms and conditions of the CAPTools Licence. These are set out in the document $(CAPHOME)/lib/captool.licence or is veiewable from our web page. 1.6 Obtaining and installing a licence string --------------------------------------------- You will need to obtain a licence string to run CAPTools. Currently each workstation requires a unique string. Before we can send you a licence string you will need to: a) Fill in the online form on our website if you have not already done so. This can be found at http://captools.gre.ac.uk/application.html Send us details of the machines you require licence strings. You can do this in 2 ways. i) Run the caphostid program. The caphostid program is located in the distribution in $CAPHOME/bin/$(CAPTOOLMACH)/caphostid (where CAPTOOLMACH is the machine architecture name, e.g. sun, sgi. You can also download the appropriate caphostid program from our website. Run caphostid on each workstation that you require licence to run CAPTools on. Note that for different architectures e.g. sun,sgi you will require a different caphostid program. ii) If you have installed the CAPTools distribution and setup the environment you can just type "captool" or "captool -licence". Either of these methods will print out the required licence information. b) Sign and send us a copy of the CAPTools Beta test licence agreement. The licence agreement is available online at http://captools.gre.ac.uk/licence.ps or in the CAPTools distribution in $(CAPHOME)/lib/captool.licence. When we receive your application and the signed licence agreement we will send you licence strings. Place the licence strings in $CAPHOME/lib/licence.dat. You should now be able to run captools. 2.0 RUNNING CAPTools -------------------- If your environment has been set up correctly you should only need to type captool There are examples in the directory $CAPHOME/examples. The User manual contains a tutorial section working through these examples. We strongly suggest you work your way through them before attempting to parallelise your own codes. For more detailed information on using CAPTools please refer to the CAPTools User Manual which is available for download from the website in postscript form. 3.0 COMPILING AND RUNNING CAPTOOLS GENERATED CODE ------------------------------------------------------------------------------ 3.1 Caplib supported enviroments and machines ------------------------------------------- CAPTools generates code that requires linking to the CAPTool's Communication Library (CAPLib). CAPLib may be downloaded seperately from the CAPTools web site. See the downloads page at http://captools.gre.ac.uk. Currently CAPLib supports SGI, SUN, CRAY T3D/T3E, IBM SP2, SGI Origin, Fujitsu AP3000/VPP/VX and Transtech Paramid. CAPLib makes calls to the underlying communications system. Currently CAPLib is implemented over PVM3, MPI, Ctoolset and Cray SHMEM. Different versions of CAPLib can coexist in the same directory structure so you can happily download several versions for different machines and have them live in the same overall directory. For support on other enviroments please contact the CAPTool's group at address below. More detailed instructons on how to compile with CAPLib are given in the CAPLib user guide. However, here are the basics: 3.2 Compiling generated code - Basics ------------------------------------- the script capmake can be used to compile your generated parallel code into an executable. e.g. capmake fabpar will look for a file called fabpar.f in the current directory and compile it for running the default parallel environment you have CAPLib set up for. Type capmake to see all the options. For code stored in a number of files you can adapt the makefile $(CAPHOME)/lib/cap.mak to suit your requirements. 3.3 Running generated code - Basics ----------------------------------- The script caprun, caprun860, caprunpvm3 can be used to run your generated code. The caprun script is a wrapper calling caprun860, caprunpvm3 etc depending on your choice. e.g. caprun -top pipe4 fabpar which, if the default CAPLib Parallel Environment Type is PVM3, is equivalent to caprunpvm3 fabpar This will run fabpar under the PVM3 enviroment (assuming of course you linked the correct library). You can run on several machines, e.g. caprun -hosts a,b,c fabpar or you could use caprun -hostfile hostfile fabpar where hostfile contains a list of hostnames one per line. Use the command line option -top to specify a processor topology to run on. e.g. caprun -top pipe4 fabpar 4.0 FUNCTIONALITY ----------------- For information in the functionality available in this release see the file $(CAPHOME)/RELEASENOTES-2.0Beta 5.0 REPORTING BUGS ------------------ There are almost certainly bugs we have not found in this version. A list of general bugs fixed and also features added since 2.0Beta-001 release can be found in the file HISTORY. Please report any bugs you find as soon as possible to the address below. 6.0 CONTACT INFORMTATION ------------------------ For more information and licensing contact: CAPTools User Support Parallel Processing Group Faculty of Technology University of Greenwich Wellington Street Tel: (+44) (0)181-331-8731/8655 Woolwich Fax: (+44) (0)181-331-8665 London SE18 6PF Email: captool-support@gre.ac.uk