home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Misc / SPICE3F4.LHA / readme < prev    next >
Encoding:
Text File  |  1994-10-11  |  17.1 KB  |  439 lines
  1.  
  2.  
  3.                                 July, 1993
  4.  
  5.     Spice3f4
  6.  
  7. ---------- New features in Spice3f.4
  8.  
  9. With this release, the University of California will no longer
  10. be providing technical support for Spice3, and no plans have been made
  11. for providing support any time in the future.  Some work on Spice3 will
  12. continue (notably the BSIM-3 model and perhaps other device models).
  13.  
  14. The following is a list of new features and fixes from the previous
  15. release of Spice3, 3f.3 (note that 3f.4 is a "last minute" release with
  16. only a few new changes):
  17.     Initial conditions specified across voltage sources is now handled
  18.     "alter" command accepts expressions, new syntax is either:
  19.         alter dev param = expr
  20.         alter @dev[param] = expr
  21.     "altermod" command for altering model parameters (was "alter")
  22.     minor bug fixes
  23.  
  24. The following is a list of new features and fixes from the previous
  25. major release of Spice3 (3f.2) and the previous release (3f.3) (note
  26. that 3f.3 is primarily a bug-fix release over 3f.2):
  27.     Added non-linear controlled source functions "u(x)" and "uramp(x)"
  28.     Fixes to AC sensitivity calculation
  29.     Fixes to initial conditions code
  30.     Fixed spurious error messages when running multiple anaylses in
  31.         batch mode
  32.     Fixed plotting (again)
  33.     Fixed "available memory" calculation
  34.     Fixed default scale to be log for analysis done by decade/octave
  35.         (ac, disto, noise); use plot option "linear" to override
  36.     Fixed asciiplot
  37.     Fixed problem causing BSIM models to not be found
  38.     Removed "spiced" (a remote-spice daemon for BSD unix); added an
  39.         rspice command which uses "rsh" instead.
  40.     Online help info is now identicle to the "Spice3f User's Manual"
  41.     Fixed numerous and various parsing errors
  42.     "TF" analysis output is now identified as "TF" data, not "DC" data
  43.     Complex numbers and Real vectors are now printed by the
  44.         "show"/"showmod" commands
  45.     Fixes to help MacIntosh port
  46.     Port for DEC Alpha running OSF/1
  47.     Misc. changes to improve portability
  48.  
  49. Additional features since release 3e.2 are:
  50.     AC and DC Sensitivity.
  51.     MOS3 discontinuity fix ("kappa").
  52.     Added a new JFET fitting parameter.
  53.     Minor initial conditions fix.
  54.     Rewritten or fixed "show" and "trace" commands.
  55.     New interactive commands "showmod" and "alter".
  56.     Minor bug-fixes to the Pole-Zero analysis.
  57.     Miscellaneous bug fixes in the front end.
  58.  
  59.  
  60.  
  61. ----------  Systems supported
  62.  
  63. Spice3f.4 has been compiled and and run under the following operating systems:
  64.     OSF 1, DEC Alpha
  65.     Ultrix 4, RISC or VAX
  66.     SunOS 4, Sun3 or Sun4
  67.  
  68. The following systems have been successfully tested either in the past or
  69. by someone outside of UC Berkeley.
  70.     MS-DOS on the IBM PC, using MicroSoft C 5.1 or later
  71.     AIX V3, RS/6000
  72.     HP-UX 8.0, 9000/700
  73.     Dynix 3.0, Sequent Symmetry or Balance (does _not_ take advantage of 
  74.         parallelism)
  75.     HP-UX 7.0, 9000/300
  76.     Irix 3.2, SGI Personal Iris
  77.     NeXT 2.0
  78.     Apple MacIntosh, Using Think C
  79.  
  80. Other systems may require a small amount of porting effort.  Note that
  81. the 'gcc' C compiler was used successfully to compile Spice3f.4.
  82.  
  83. Due to the heavy use of floating point math operations, Spice3 on the
  84. PC requires a math co-processor.  Also, on the PC, SVGA displays are
  85. _not_ supported.  Only CGA, EGA, and VGA displays are supported (via
  86. the MicroSoft graphics library) at this time.
  87.  
  88. A 68020 or better processor and a math co-processor is required for
  89. the MacIntosh.
  90.  
  91. Systems using the X11 Window System (generally any "workstation" class
  92. of system) must have the MIT Athena Widget Set  available ("libXaw.a"
  93. and possiblely "libXmu.a").  These are frequently not distributed or
  94. distributed as "usupported software" by commercial workstation
  95. vendors.
  96.  
  97. ---------- Unloading Spice3 from disk or tape
  98.  
  99. The Unix distribution comes on 1/2" 9-track tape, 8mm tape, or DEC TK50 tape
  100. in "tar" format.  The MS-DOS distribution comes on several 3.5" floppy
  101. diskettes (both high and low density) in the standard MS-DOS format.
  102. The contents of both distributions are identical, including filenames,
  103. except for the additional files on the MS-DOS disks used for automatic
  104. unloading.
  105.  
  106. The source code and associated data files for spice3f.4 require over 6MB,
  107. and up to an additional 22MB may be required to compile under Unix (for a
  108. DEC RISC workstation with the compiler option '-g').  For MS-DOS using
  109. MicroSoft C 5.1 or later, nearly 8MB (beyond the 6MB for the source) is
  110. required.
  111.  
  112. UNIX:  The UNIX distribution of Spice3f.4 comes in "tar" format.  To
  113.     extract Spice3f.4 first create the directory that you wish to
  114.     hold the distribution and "cd" into that directory.  Then
  115.     execute the command "tar x" (after mounting the tape).  Note
  116.     that some sites may require that you explicitly indicate the
  117.     tape drive name when using the "tar" command; this is done with
  118.     the 'f' flag, for example "tar xf /dev/rmt0h".
  119.  
  120. MS-DOS:  Spice3f.4 comes on MS-DOS format 3.5" disks.  To extract the
  121.     distribution onto a hard disk, create the directory on the hard
  122.     disk that you wish to hold the source code.  "cd" into that
  123.     directory on the hard disk.  For each of the distributed disks,
  124.     IN ORDER, insert the disk into the drive (we'll assume drive
  125.     "B:" here), and enter "B:UNLOAD B:".  This will use the script
  126.     "unload.bat" to extract the source files off of the disk and
  127.     into the current directory or a subdirectory of the current
  128.     directory.  You might see the error "File not found ????????.???",
  129.     that is normal.
  130.  
  131. Converting the MS-DOS format disks to UNIX:  The MS-DOS format is not
  132.     directly readable by UNIX systems.  One publically available
  133.     tool for doing this is known as "mtools" (search popular
  134.     ftp sites), but this is not the only method.  Note: In MS-DOS,
  135.     text file lines end with "^M^J", where under UNIX lines end only
  136.     with "^J".  Also, execute permission needs to be set on all
  137.     files in the "util/" subdirectory when moving to UNIX.
  138.     
  139. MAC:  Spice3 is not distributed in a format for the Apple MacIntosh.  You
  140.     must determine how to transfer the files to a Mac from the media that
  141.     you have.
  142.  
  143. ---------- Compiling Spice3f.4 under UNIX
  144.  
  145.     To build Spice3f.4 on a Unix system follow the steps below.
  146.     For additional notes on internal changes and porting issues,
  147.     please inspect the subdirectory "notes".
  148.  
  149.     First you must edit the file "conf/defaults" and change the
  150.     listed parameters to reflect the standard organization of
  151.     software at your site.  A description of each parameter is
  152.     included in this file.
  153.  
  154.     Second, for each type of system at your site, you must provide
  155.     a file in the same subdirectory ("conf/") which contains
  156.     exceptions to the previously edited "defaults" file; note that
  157.     even if you are supporting one type of system with no
  158.     exceptions this is still necessary.  Several files are supplied for
  159.     the system types that have been tested with this distribution,
  160.     including "mips" (for DECstations), "sun4", "sequent", "irix",
  161.     "hpux", and "rs6000".
  162.  
  163.     Note that some of these per-system definition files have
  164.     special definitions which are required for the given system and
  165.     which do not appear in the "defaults" file.
  166.  
  167.     Note also that successful compiling does not depend on the
  168.     particular names given to these 'exception' or 'system
  169.     definition' files.  For example, the "mips" configuration file
  170.     could have been named "decstation"; this name is used for
  171.     generating unique directory names such that different systems
  172.     to not use the same area for the compile process (more detail
  173.     are listed in the "defaults" file).
  174.  
  175.     Finally, it is possible to combine additional files
  176.  
  177.     After the defaults file has been edited and a system-dependent
  178.     file created or modified, run the command "util/build system"
  179.     from the directory above the "util" subdirectory; for "system"
  180.     you must substitute the name of the system-dependent file that
  181.     you created or modified in the previous step.  Spice3 will then
  182.     be built via recursive "make" commands (it may take a several
  183.     seconds to get going on some systems).  The total time can be
  184.     as little as 20 minutes or as long as four hours depending on
  185.     the speed and load of your system.  Compiling across NFS will
  186.     slow down compiling significantly.
  187.  
  188.     If you have trouble using the "build" script, try "build -help"
  189.     for infomation on debugging options.  Some system combinations
  190.     may require listing more than one system name on the "build" line,
  191.     for example "build hpux hp300" to build on an HP 9000/300 as
  192.     opposed to a HP 9000/700.  When the build script has successfully
  193.     completed, see the section below on Installing Spice3.
  194. ---------- Additional Notes on Compiling Spice3f.4 under UNIX
  195.  
  196.     NOTE: Some systems have a problem with directory names containing
  197.     a "-" in either the full source directory name or the full directory
  198.     name of any program used in compiling.  This may show up as an
  199.     unexpected or unreasonable error message.  Avoid directory names
  200.     with a "-" (this is an old bug in the "make" command, which has
  201.     propagated to many vendors before being fixed).
  202.  
  203.     NOTE: On some systems, the "build" scripts seems sluggish.  This
  204.     may be caused by a long "$PATH", with many entries before "/bin"
  205.     and "/usr/bin"; you may be able to speed up the script by trimming
  206.     your "$PATH" before running the build script.
  207.  
  208.     NOTE (SunOS):  There is small bug somewhere in one version of the
  209.     Sun-supplied X11 libraries.  This bug results in the following
  210.     routines being undefined in the "link" stage:
  211.  
  212.         _get_wmShellWidgetClass
  213.         _get_applicationShellWidgetClass
  214.  
  215.     This is apparently a problem with the dynamic-link version of the
  216.     "Xmu" library.  If you have this problem, the best reported fix is
  217.     to use the following options on the "link" line (embed the following
  218.     in the LIBX variable in "conf/sun4", or wherever):
  219.  
  220.         -Bstatic -lXmu -Bdynamic
  221.  
  222.     This is anticipated in a comment in the current copy of "conf/sun4".
  223.  
  224.     NOTE: GNU make is not compatible with the traditional "make", and
  225.     is not compatible with spice3.  Using GNU make may result in
  226.     infinite recursion.
  227.  
  228.  
  229. ---------- Compiling under MS-DOS with MicroSoft C 5.1:
  230.  
  231.     The PC lacks the program "/bin/sh" (and others) which the above
  232.     Unix installation depends on.  Instead we have supplied simple
  233.     compiling scripts for use with MicroSoft C 5.1.  This less
  234.     flexible system requires that you edit several files before building:
  235.  
  236.         src/bin/tunepc.c (built-in file locations); Change the values
  237.             of the following C variables as appropriate -- leave
  238.             double quote and single quote marks as-is, and use
  239.             two backslash ('\') characters where you want one:
  240.  
  241.             Spice_Exec_Dir: location you plan to install spice.
  242.  
  243.             Spice_Lib_Dir: location you plan to install the spice
  244.                 startup and data files.
  245.  
  246.             Spice_OptChar: command line option character
  247.                 (indicates whether you want to type
  248.                 "spice -r" or "spice /r").
  249.  
  250.             Def_Editor: location you plan to install spice
  251.  
  252.             AsciiRawFile: location you plan to install spice
  253.  
  254.             The last three options (not listed here) are not
  255.             significant under MS-DOS, but should be left as is
  256.             (blank).
  257.  
  258.         src/bin/cconf.c        Devices and analyses for "cspice"
  259.         src/bin/bconf.c        Devices and analyses for "bspice"
  260.  
  261.             The initial segment of "cconf.c" and "bconf.c"
  262.             are "#define" lines that determine which devices
  263.             and analyses should be compiled in to the simulator.
  264.             For devices, the line looks like "#define DEV_xxx"
  265.             where "xxx" is the name of some device;  For
  266.             analyses, the line looks like "#define AN_xxx".
  267.             Names and descriptions of both analyses and devices
  268.             are as listed below ("Devices and Analyses supported
  269.             in Spice3f.2", at the end); see also the user's manual.
  270.             A reasonable default is supplied with each.
  271.             Do not modify anything below the list of '#define'
  272.             lines.
  273.         (more)
  274.  
  275.         src/include/os_msdos.h
  276.             If you do not want the spice-supplied "hardcopy"
  277.             routine for sending plots to an IBM Personal
  278.             Graphics Printer (or equivalent), comment out the
  279.             "#define WANT_PCHARDCOPY" line near the bottom.
  280.             Some versions of MS-DOS can't normally send VGA
  281.             graphics to a printer.
  282.  
  283.     Once these files have been edited, "cd" into the top directory
  284.     (above "util\", "src\", and "conf\") and run "msc51.bat".  The
  285.     script first sets compiler options in the environment and then
  286.     procedes with the compile.  Since the environment may not have
  287.     enough room, you may have to clear some unused environment
  288.     variables before the build, otherwise the build could fail.
  289.     Note that these options are only useful for MicroSoft C 5.1 or
  290.     later.
  291.  
  292.     Compiler errors are written to the file "src\msc.out".  This
  293.     includes many warnings because Spice3 was originally written in
  294.     pre-ANSI C (or "K&R" C) under Unix.  Except for these (numerous)
  295.     warnings, Spice3 should compile and run without trouble; see the
  296.     next section on installing.
  297.  
  298.     Cleaning up under MS-DOS (after installing):
  299.  
  300.     To delete the original source tree from your hard disk, you may
  301.     use the supplied script "util\delall.bat".  You must copy
  302.     this script outside of the source tree before you run it or it
  303.     will remove itself before finishing.  Run the script from the top
  304.     directory of the source tree (above "util\").
  305.  
  306. ---------- Compiling on the MacIntosh
  307.  
  308.     Since there is no scripting language on the Mac, you must do
  309.     considerable work to build spice3 on a Mac.  The details
  310.     are included in a seperate file, "notes/mac_port".
  311.  
  312. ---------- Installing Spice3
  313.  
  314.     After spice3 and the associated programs have been created, you may
  315.     test the program.  There are a few test inputs in the "examples"
  316.     subdirectory.
  317.  
  318.     Because spice3 is not installed in it's final destination at this
  319.     point, you should set the environment variable "SPICE_LIB_DIR" to
  320.     the "lib" subdirectory to indicate the location of some startup files.
  321.  
  322.     Finally, you may install spice3 and associated components into
  323.     a standard place.  Under Unix systems, the command "util/build
  324.     system install" will do this automatically (again substitute
  325.     your system name or type for "system").  Under MS-DOS or for
  326.     the MacIntosh, the files must be copied explicitly.
  327.  
  328.     The executable programs are from the subdirectories "src/bin",
  329.     as follows:
  330.         spice3        UNIX only: the simulator.
  331.         bspice        MS-DOS only: a batch mode simulator:
  332.                 "bspice < input.cir" generates the file
  333.                 "rawspice.raw", which is read by "nutmeg"
  334.                 (see below).
  335.         cspice        MS-DOS only: a spice2 like interface for
  336.                 small runs (runs out of memory easily).
  337.                 Use "cspice < input.cir"; generates
  338.                 'asciiplots' for .plot lines.
  339.         nutmeg        A stand-alone data analysis program;
  340.                 Spice3 without the simulation capability.
  341.         help        A stand alone help browser.
  342.         proc2mod    Converts process characterization files
  343.                 to Spice3 BSIM1 MOS model definitions.
  344.         sconvert    Converts between ascii and binary spice
  345.                 data files (".raw" files).
  346.         multidec    A utility for decomposing coupled lossy
  347.                 transmission lines into equivalent uncoupled
  348.                 lines.  Not available on MS-DOS (need the
  349.                 "getopt" library).
  350.  
  351.     The following startup/data files are installed from the "lib/"
  352.     subdirectory:
  353.         helpdir/spice.txt    on-line information for spice3.
  354.         helpdir/spice.idx    index for spice.txt, generated with
  355.                         the program "bin/makeidx".
  356.  
  357.         scripts/spinit        spice/nutmeg commands executed at
  358.                         startup.
  359.         scripts/setplot        A script for the command "setplot".
  360.  
  361.         news            a start up message of your choosing.
  362.         mfbcap            graphics-terminal capability database
  363.                     (not required for MS-DOS).
  364.  
  365.     (Previous versions had a seperate help files for spice3 and
  366.     nutmeg;  the current help file is now identicle to the "Spice3f4
  367.     User's Manual", so there is no distinction).
  368.  
  369.     For the PC and MacIntosh, you must generate the ".idx" files
  370.     yourself by running "makeidx spice.txt".  Unix "man" pages are
  371.     also supplied for the programs spice, nutmeg, and sconvert, for
  372.     the mfb database format (looks like termcap), and for the mfb
  373.     library.  These are not installed automatically as they are
  374.     old, unsupported, and may be out of date.
  375.  
  376. Devices and Analyses supported in Spice3f.4:
  377.     For reference, the following is a list of all devices and their
  378.     common abbreviation in Spice3:
  379.  
  380.         asrc:    arbitrary voltage/current source
  381.         bjt:    bipolar junction transistor
  382.         bsim1:    detailed MOS model
  383.         bsim2:    detailed MOS model, revised version of bsim1
  384.         cap:    capacitor
  385.         cccs:    current-controlled current source
  386.         ccvs:    current-controlled voltage source
  387.         csw:    current controlled switch
  388.         dio:    diode
  389.         ltra:    lossy transmission line
  390.         ind:    inductor
  391.         isrc:    current source
  392.         jfet:    Junction FET
  393.         mes:    MES FET (GaAs)
  394.         mos1:    MOS, simplest analytic model, fastest
  395.         mos2:    MOS, middle complexity and accuracy
  396.         mos3:    MOS, most complicated, most accurate
  397.         mos6:     MOS, new, fast analytic, short-channel
  398.         res:    resistor
  399.         sw:    switch
  400.         tra:    lossless transmission line
  401.         urc:    uniform RC line
  402.         vccs:    voltage-controlled current source
  403.         vcvs:    voltage-controlled voltage source
  404.         vsrc:    voltage source
  405.  
  406.     The following is the corresponding list of analyses:
  407.         op:    DC operating point
  408.         dc:    DC transfer curve
  409.         tf:    Small signal transfer function
  410.         ac:    AC (frequency domain)
  411.         tran:    transient
  412.         pz:    pole-zero
  413.         disto:    distortion
  414.         noise:    noise
  415.         sense:    sensitivity
  416.  
  417.  
  418.  
  419. Technical Problems
  420.  
  421.     Spice no longer has technical support from the
  422.     University of California.  If you have problems with the
  423.     media or questions about ording spice3, you may send email to:
  424.  
  425.         software@eecs.berkeley.edu
  426.  
  427.     or (via US Mail):
  428.   
  429.         EECS/ERL Industrial Support Office
  430.         Attn: Spice Technical Question
  431.         205 Cory Hall
  432.         U.C. Berkeley
  433.         Berkeley, CA   94720
  434.  
  435.  
  436.     Patches for some previous version of spice3 are available via
  437.     anonymous ftp from ic.berkeley.edu, in the subdirectory "pub/spice3/".
  438.  
  439.