Goto Chapter: | Top | 1 | 2 | 3 | 4 | 5 | 6 | Bib | Ind

### 6. Installation and auxiliary functions

#### 6.1 Requirements

The RCWA Package needs at least version 4.4 of GAP, is completely written in the GAP language and does neither contain nor require external binaries. It needs the package ResClasses for dealing with set-theoretic unions of residue classes, and the package GRAPE [S02] for dealing with certain graphs associated to rcwa mappings (cp. `TransitionGraph` (2.8-1)). The binaries of GRAPE are not needed, thus RCWA runs under Windows and on the MacIntosh as well. Warnings concerning missing binaries when GRAPE is loaded can savely be ignored. For the documentation the package GAPDoc [LN02] is needed.

#### 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 Building the manual

##### 6.3-1 RCWABuildManual

`> RCWABuildManual`( ) | ( function )

Returns: Nothing.

This function builds the manual of the RCWA package in the file formats LaTeX, DVI, Postscript, 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 LaTeX and a few other tools, but should normally not be necessary as all files generated by this function are included in the distribution file anyway.

#### 6.4 The Info class of the package

##### 6.4-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.5 The testing routine

##### 6.5-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`.

Top of Book | Previous Chapter | Next Chapter

Goto Chapter: | Top | 1 | 2 | 3 | 4 | 5 | 6 | Bib | Ind

generated by GAPDoc2HTML