6. Installation and auxiliary functions

6.1 Requirements

The RCWA package needs at least GAP 4.4.7, ResClasses 2.4.0, GRAPE 4.0 [S06], Polycyclic 2.1 [EN06] and GAPDoc 0.999 [LN06]. With possible exception of the most recent version of ResClasses, all needed packages are already present in an up-to-date standard GAP installation. The RCWA package can be used under UNIX, under Windows and on the MacIntosh. It is completely written in the GAP language and does neither contain nor require external binaries. In particular, warnings concerning missing binaries when GRAPE is loaded can savely be ignored.

6.2 Installation

Like any other GAP package, RCWA must be installed in the pkg subdirectory of the GAP distribution. This is accomplished by extracting the distribution file in this directory. If you have done this, you can load the package as usual via LoadPackage( "rcwa" );.

6.3 The Info class of the package

6.3-1 InfoRCWA
> InfoRCWA( info class )

This is the Info class of the RCWA package. See section Info Functions in the GAP Reference Manual for a description of the Info mechanism. For convenience: RCWAInfo(n) is a shorthand for SetInfoLevel(InfoRCWA,n).

6.4 The testing routine

6.4-1 RCWATest
> RCWATest( )( function )

Returns: Nothing.

Performs tests of the RCWA package. Errors, i.e. differences to the correct results of the test computations, are reported. The processed test files are in the directory pkg/rcwa/tst.

6.5 Building the manual

The following routine is a development tool. As all files it generates are included in the distribution file anyway, users will not need it.

6.5-1 RCWABuildManual
> RCWABuildManual( )( function )

Returns: Nothing.

This function builds the manual of the RCWA package in the file formats LaTeX, PDF, HTML and ASCII text. This is accomplished using the GAPDoc package by Frank Lübeck and Max Neunhöffer. Building the manual is possible only on UNIX systems and requires PDFLaTeX.




generated by GAPDoc2HTML