Snark09 - Documentation

Veryfying Installation:

Upon completion of SNARK09 installation, various executable binaries and scripts will be located in the system directory that you either specified or allowed the install script to choose for you. (The default installation location for these executables is /usr/local/snark09/bin/.)

You should verify that the following executable files are in fact installed:

snark09
snark09GetExamples
snark09GetUserDefined

If you installed SNARK09 utilities: SNARK09INPUT and SNARK09DISPLAY, then you should have

snark09Input
snark09Display

SNARK09 comes with a set of ten examples that can be used for veryfying of correct insallation. The script snark09GetExamples can be used to obtain a local copy of the examples and their output should be compared with the output listed in the SNARK09 Manual.

snark09GetExamples may be used by any user to create a local copy of the directory containing all example input files and reference output files that come with the SNARK09 installation.

snark09GetExamples creates a directory called snark09Examples/, which contains subdirectories (b1/, b2/, b3/, b4/, b5/, b6/, b7/, b8/, b9/, b10/) for each of of the ten examples. Each of these ten example subdirectories contains a script, run, which may be invoked by typing at the command prompt (within the example's subdirectory): ./run. This executes SNARK09 on the given example's input file.

For example, to set up the SNARK09 examples in your home directory you would do the following:

Move to your home directory by typing
$ cd ~/
Invoke the script snark099GetExamples
$ snark09GetExamples
(If you setup the evironmental variables correctly snark09GetExamples can be invoked from anywhere in the system.)
Follow the script's instructions regarding the location to set up the snark09Examples/ directory)

For quickly running all examples and making sure that the output you receive is the same as ours, you can download and run the following two scripts: run_all and regression. Place them in the directory snark09Examples/ that you created before and add the executable permission bit

$ chmod a+x run_all

$ chmod a+x regression

You can run the scripts by typing

$ ./run_all

$ ./regression

Script run_all executes each of the examples and prints outputs to files named after the example number in the directory of a given example. For example the output of example b1 is called b1.out. The second script, regression, compares the output that you just obtained to output that we received (each example has a file called, for example, b1r.out that illustrates correct output). If there are no differences found, your installation went fine.

If you want to run SNARK09 examples manually one by one, for example b1, you would do the following:

Move into example b1's subdirectory
$ cd snark09Examples/b1
Run example b1
$ ./run
The output is printed to the screen.

You may of course decide to set up the snark09Examples/ directory wherever you desire. Simply respond to the snark09GetExamples script's prompt accordingly.

>> Notes >>