<!-- #################################################################### -->
<!-- ##                                                                ## -->
<!-- ##  rcwaaux.xml         RCWA documentation           Stefan Kohl  ## -->
<!-- ##                                                                ## -->
<!-- ##  $Id: rcwaaux.xml,v 1.24 2005/06/03 09:19:32 stefan Exp $      ## -->
<!-- ##                                                                ## -->
<!-- #################################################################### -->

<Chapter Label="ch:InstallationAndAuxiliaryFunctions">
<Heading>Installation and auxiliary functions</Heading>

<!-- #################################################################### -->

<Section Label="sec:Requirements">
<Heading>Requirements</Heading>

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 <Package>GRAPE</Package>
<Cite Key="GRAPE"/> for dealing with certain graphs associated
to rcwa mappings (cp. <Ref Oper="TransitionGraph" Label="f, m"/>).
The binaries of <Package>GRAPE</Package> are not needed, thus &RCWA; runs
under Windows and on the MacIntosh as well. Warnings concerning missing
binaries when <Package>GRAPE</Package> is loaded can savely be ignored.

For the documentation the package &GAPDoc; <Cite Key="GAPDoc"/> is needed.

</Section>

<!-- #################################################################### -->

<Section Label="sec:Installation">
<Heading>Installation</Heading>

Like any other &GAP; package, &RCWA; must be installed in the <F>pkg</F>
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 <C>LoadPackage( "rcwa" );</C>.

</Section>

<!-- #################################################################### -->

<Section Label="sec:BuildingTheManual">
<Heading>Building the manual</Heading>

<ManSection>
  <Func Name="RCWABuildManual" Arg=""/>
  <Returns> Nothing. </Returns>
  <Description>
    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.
  </Description>
</ManSection>

</Section>

<Alt Only="LaTeX">\pagebreak[4]</Alt>

<!-- #################################################################### -->

<Section Label="sec:TheInfoClass">
<Heading>The Info class of the package</Heading>

<ManSection>
  <InfoClass Name="InfoRCWA"/>
  <Description>
    This is the Info class of the <Package>RCWA</Package> package.
    See section <E>Info Functions</E> in the &GAP;
    Reference Manual for a description of the Info mechanism. <P/>

    For convenience: <C>RCWAInfo(</C><A>n</A><C>)</C> is a shorthand for
    <C>SetInfoLevel(InfoRCWA</C>,<A>n</A><C>)</C>.
  </Description>
</ManSection>

</Section>


<!-- #################################################################### -->

<Section Label="sec:TheTestingRoutine">
<Heading>The testing routine</Heading>

<ManSection>
  <Func Name="RCWATest" Arg=""/>
  <Returns> Nothing. </Returns>
  <Description>
    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
    <F>pkg/rcwa/tst</F>.
  </Description>
</ManSection>

</Section>

</Chapter>

<!-- #################################################################### -->
