README

   1 Readme for gnucap-uf 0.0.2
   2
   3 this forks from gnucap and includes several experiments and workarounds.
   4 there exist plans to seperate out improvements and fold back to upstream.
   5
   6 === build system ===
   7
   8 see INSTALL. for better coexistance with other gnucap releases, you may want to
   9 configure --with-program-suffix=-uf.
  10
  11 === regression test suite ===
  12
  13 gnucap-uf implements an automated test suite (automake based, with noise
  14 filter). the directory 'tests' contains a set of tests that should pass before
  15 installation. type "make check". some tests are known to fail (XFAIL_TESTS),
  16 these are meant to document problems. feel free to contribute patches.
  17
  18 === module compilation ===
  19
  20 compile a plugin from source code
  21 $ gnucap.mk file.so
  22
  23 compiles cc to so prior to dlopen.
  24 gnucap> load file.cc
  25
  26 === Two time analysis (aging etc.) ===
  27
  28 .ttr [ Tstart ] Tstop [ tstop tstep ] [<args>]
  29 args are
  30 * <multiplier>, increase timestep multiplicatively.
  31 cont: continue with aged node values
  32 cont_dc: continue from dc operating point
  33 new: start with fresh devices
  34
  35 EXAMPLES
  36 see regression tests.
  37
  38 === dc analysis ===
  39
  40 - takes uic argument. compute solution close to specified initial conditions.
  41 - improve dc sweep initial values and fallback in case of non-convergence.
  42
  43 === dynamic dc analysis ===
  44
  45 .ddc command. like .dc, but provides dv probe for voltage nodes.
  46
  47 EXAMPLES
  48 spice
  49 c1 0 1 ic=1
  50 r1 0 1 1
  51 .print dv(1)
  52 .ddc
  53
  54 see regression tests
  55
  56 === sensitivity analysis ===
  57
  58 - sensitivity probes in .ac analysis.
  59 - .sens command
  60
  61 EXAMPLES
  62 see regresion tests
  63
  64 === remote control ===
  65
  66 the .sock command starts an interactive command for direct communication with
  67 the simulator kernel. this is for academic purposes only.