********************************************************************************
*                            s2ibis README file                                *
********************************************************************************

    This directory contains the source code, executables, example test file, and
documentation for s2ibis Version 1.2.  

    The source code is in the subdirectory named src; the executables are in the 
subdirectory named bin; the example test file, tryme, is in the subdirectory 
named test; and the latest documentation is in the subdirectory named man.

    To test s2ibis on your machine, rename the appropriate executable in the 
S2IBIS/bin directory to S2IBIS/bin/s2ibis, make sure that S2IBIS/bin is in your 
path, and that spice3 is in your path. ( If you want to use another version of 
SPICE you need to modify the [Spice] line in the header of tryme as described in
the man pages.) Then go to the S2IBIS/test directory and type:

                          s2ibis tryme tryme.ibs

    The resulting output file tryme.ibs should be very similar to the 
tryme.ibs.correct file I have provided.  PLEASE NOTE: this command will generate 
about 150 files, a total disk space requirement of about 400 kilobytes if you 
use the default SPICE3.  If you switch to HSPICE, 300 files will be generated, 
requiring two (2) megabytes of disk space.  Please note that I have not tried
the v1.2 tryme file with HSPICE because our HSPICE license has temporarily
lapsed.  If you have trouble getting tryme to work with HSPICE (convergence
errors etc.) please try the tryme.v1.0 file instead.  This is a simpler
implementation of the same circuit and it has been tested using HSPICE.  If 
you do get the new tryme file to work using HSPICE I would appreciate it if
you could let me (slipa@eos.ncsu.edu) know. 

    To make the man pages work you have to add an element to your MANPATH 
environment variable that points to S2IBIS/man.   Alternatively you can just 
print out S2IBIS/man/man1/s2ibis.txt, or you can move the file 
S2IBIS/man/man1/s2ibis.1 to one of the man/man1 subdirectories pointed to by 
your MANPATH.   The file named FAQ in the S2IBIS/man/man1 directory contains 
answers to Frequently Asked Questions about s2ibis.  It may be useful if you 
have problems getting started.

    Please let me know if you have any problems or questions.

Steve
slipa@eos.ncsu.edu
