spicefile/README

   1
   2 libspicefile - a library for reading analog waveform data files of the
   3 sort generated by spice-type simulators, and similar data files.
   4
   5 We've called the library spicefile instead of wavefile because:
   6 - at present, only analog waveforms of represented by floating-point numbers
   7 are handled.
   8 - We want to avoid confusion with the "wav" format for soundfiles.
   9
  10
  11 Our model for datafiles of this sort is as follows: Files contain a
  12 single independent variable, and zero or more dependent variables.
  13 Files can be thought of as organized into "rows" and "columns."  The
  14 first column is the independent variable, remaining columns are
  15 associated with dependent variables.  A single dependent variable may
  16 comprise several columns; for example complex variables occupy two
  17 columns, one for the real part and one for the imaginary part.  Each
  18 row contains a one value for the independent variable and one value
  19 for each of the dependent variables.
  20
  21 Two different levels of abstraction are provided, SpiceStream and WaveFile.
  22
  23 A SpiceStream is like an open file from which one row of datapoints is
  24 read at a time.
  25
  26 A WaveFile comprises all of the datapoints for all values of the
  27 independent variable, suitable for fast random access.  It is implemented
  28 using a SpiceStream to read a whole file into memory.
  29
  30
  31 Two complete programs are provided.
  32
  33 sp2sp ("spice to spice") uses SpiceStream to convert any file format
  34 supported by the SpiceStream layer into one of several ASCII printable
  35 formats.  In addition to testing the SpiceStream code, this is
  36 extremely useful for converting files any of the binary formats into a
  37 printable form, where they can easily be processed by awk, perl, or
  38 some other scripting language.
  39
  40 Test_read tests the WaveFile abstraction by loading a file into memory
  41 and printing various information about it.
  42