Goto Chapter: Top 1 2 3 4 Bib Ind
Top of Book Previous Chapter Next Chapter

4. Installation and auxiliary functions
4.1 Requirements
4.2 Installation
4.3 The testing routine
4.3-1 ResClassesTest
4.4 Building the manual
4.4-1 ResClassesBuildManual

### 4. Installation and auxiliary functions

#### 4.1 Requirements

The ResClasses package needs at least GAP 4.4.7 and GAPDoc 0.99999 [LN06]. It can be used under UNIX, under Windows and on the MacIntosh. ResClasses is completely written in the GAP language and does neither contain nor require external binaries.

#### 4.2 Installation

Like any other GAP package, ResClasses must be installed in the `pkg` subdirectory of the GAP distribution. This is accomplished by extracting the distribution file in this directory. By default, the package ResClasses is autoloaded. If you have switched autoloading of packages off, you can load ResClasses via `LoadPackage( "resclasses" );`.

#### 4.3 The testing routine

##### 4.3-1 ResClassesTest

`> ResClassesTest`( ) | ( function )

Returns: Nothing.

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

#### 4.4 Building the manual

##### 4.4-1 ResClassesBuildManual

`> ResClassesBuildManual`( ) | ( function )

Returns: Nothing.

This function is a development tool which builds the manual of the ResClasses 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. As all files generated by this function are included in the distribution file anyway, users will not need it.

Top of Book Previous Chapter Next Chapter
Goto Chapter: Top 1 2 3 4 Bib Ind

generated by GAPDoc2HTML