chap9.txt

  
  9 Installation and Auxiliary Functions
  
  
  9.1 Requirements
  
  This   version   of   RCWA   needs   at  least  GAP 4.8.7  in  64-bit  mode,
  ResClasses 4.7.0,         GRAPE 4.7 [Soi16],        Polycyclic 2.11 [EHN13],
  FR 2.2.1 [Bar15], GAPDoc 1.5.1 [LN12], and Utils 0.40 [GKW16]. 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
  is  completely  written in the GAP language and can be used on all platforms
  for which GAP is available.
  
  
  9.2 Installation
  
  Like   any  other  GAP  package,  RCWA  is  usually  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" );.
  
  
  9.3 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.
  
  9.3-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-type systems and requires PDFLaTeX.
  
  
  9.4 The testing routines
  
  9.4-1 RCWATestInstall
  
  RCWATestInstall(  )  function
  Returns:  true if no errors were found, and false otherwise.
  
  Performs  a  nontrivial computation to check whether an installation of RCWA
  appears to work. Errors, i.e. differences to the correct results of the test
  computation,     are     reported.    The    processed    test    file    is
  pkg/rcwa/tst/testinstall.tst.
  
  9.4-2 RCWATestAll
  
  RCWATestAll(  )  function
  Returns:  true if no errors were found, and false otherwise.
  
  Runs  the  full  test  suite  of  the  RCWA  package. Any differences to the
  supposed  results  of the test computations are reported. The processed test
  files are in the tst subdirectory of the package directory.
  
  Please  note  that  the  test  suite is a tool for developing. The tests are
  deliberately  very  volatile  to allow to spot possible problems of any kind
  also  in  other  packages or in the GAP Library. For this reason you may see
  reports  of  differences  which  simply  reflect  improved  methods in other
  packages  or in the GAP Library (for example an object may already know more
  of  its attributes or properties than it is expected to, or an object may be
  represented  in  a  better  way),  or which are caused by changes of the way
  certain  objects  are  printed, and which are therefore harmless. However if
  the  correct  and  the actual output look different mathematically or if you
  see  error  messages  or  if  GAP  crashes, then something went wrong. Also,
  reports  about  significantly  increased run times of individual commands as
  well  as  run  times  of test files which are much longer than the predicted
  times shown may indicate a problem.
  
  9.4-3 RCWATestExamples
  
  RCWATestExamples(  )  function
  Returns:  nothing.
  
  Runs  all  examples  in  the  manual  of  the  RCWA package, and reports any
  differences between the actual output and the output printed in the manual.
  
  
  9.5 The Info class of the package
  
  9.5-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).