<!-- #################################################################### -->
<!-- ##                                                                ## -->
<!-- ##  rcwaaux.xml         RCWA documentation           Stefan Kohl  ## -->
<!-- ##                                                                ## -->
<!-- ##  $Id: rcwaaux.xml,v 1.47 2007/05/31 15:36:57 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 &GAP;&nbsp;4.4.7, &ResClasses;&nbsp;2.5.1,
<Package>GRAPE</Package>&nbsp;4.0&nbsp;<Cite Key="GRAPE"/>,
<Package>Polycyclic</Package>&nbsp;2.1&nbsp;<Cite Key="Polycyclic"/> and
&GAPDoc;&nbsp;1.0&nbsp;<Cite Key="GAPDoc"/>. 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 issued by <Package>GRAPE</Package> or other packages
can savely be ignored.

</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: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.
    For convenience: <C>RCWAInfo(</C><A>n</A><C>)</C> is a shorthand for
    <C>SetInfoLevel(InfoRCWA</C>,<A>n</A><C>)</C>.
    <Index Key="RCWAInfo"><C>RCWAInfo</C></Index>
  </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>

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

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

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

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

</Section>

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