README for the SimEqui and enhanced Bazaar packages

Authors: Kai-hui Chang, David A. Papa, Igor L. Markov and Valeria Bertacco
Affiliation: University of Michigan at Ann Arbor

Two packages are included in this submission, including the new
SimEqui package and the enhanced Bazaar package. Their installation 
and testing will be described separately in this README file.

The SimEqui Package:
-----------------------------------------------------------------------
Installation:
1. Follow the standard OAGear package installation and setup procedures.  In
our patch we have added the SimEqui package to the top level Makefile.am
please verify that it is present after applying the patch.  In the SimEqui
package we have included a Makefile.mm.  Please run Build/setup-developer to
create the appropriate Makefile.ams and configure to create Makefiles.

Creating Documents:
1. Change directory to SimEqui/Documentation.
2. Type "make doc".
3. File oagSimEqui.pdf will be created in the same directory. It contains a 
   description of our package, a tutorial, and complete class references. 
Note: This file is also included in the submission.

Testing:
1. After compiling the package, change directory to RegressionTest under 
   SimEqui.
2. Run script check-all.
3. If installation is correct, all the tests should report PASSED.

Enhanced Bazaar Package:
-----------------------------------------------------------------------
Installation:
1. When building the Bazzar package, please ensure that the Tcl headers and 
   libraries are in the search path. The build system for the Bazaar package 
   is not tied into the metamake build system, and does not explicitly have 
   machinery for locating Tcl at configure time. If desired, this can be 
   manually added to Makefile.am instead of changing the environment of the 
   machine. Alternatively, a system install of Tcl is sufficient.
2. Because new icon files cannot be packed into the package by the
   make-oagear-patch script, a separate file named
   "simulator_bazaar_icons.tar.gz" is included in this submission. This file
   contains new icons in the OAGear/OAGear/Bazaar/Images/ directory.  Please
   uncompress and untar this file before compiling Bazaar.
3. Please ensure before running ./bazaar that the gsclib.lib file (liberty 
   file in the Cadence CRETE library used by IWLS2005 benchmarks) is in the 
   current directory. This file should be included in our patch.  The
   simulator needs this file because of the Func package. If the Func package
   stored its results in the database after each use, and checked for existence
   of this data, the dependence on this file could be eliminated.

Testing:
1. The tests of bazaar use the design database built in SimEqui/RegressionTest, 
   therefore the "check-all" script in SimEqui/RegressionTest must be 
   executed before testing Bazaar.
2. Change directory to Bazaar and run ./bazaar
3. Follow the walk-through in the documentation to test the features added
   to Bazaar and view the capabilities of the SimEqui package.
Note: Detailed installation and testing instructions can be found in the 
documentation.


