doc/sp2sp.sgml

   1 <!doctype refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
   2  ]>
   3 <REFENTRY>
   4   <REFMETA>
   5     <REFENTRYTITLE>sp2sp</REFENTRYTITLE>
   6     <MANVOLNUM>1</MANVOLNUM>
   7     <REFMISCINFO>sp2sp - translate between analog waveform formats</REFMISCINFO>
   8   </REFMETA>
   9   <REFNAMEDIV>
  10     <REFNAME>sp2sp</REFNAME>
  11     <REFPURPOSE>translate from one spice-type analog waveform file format to another
  12 </REFPURPOSE>
  13     <INDEXTERM><PRIMARY>spice</PRIMARY><SECONDARY>file</SECONDARY></INDEXTERM>
  14     <INDEXTERM><PRIMARY>waveform</PRIMARY></INDEXTERM>
  15   </REFNAMEDIV>
  16
  17   <REFSYNOPSISDIV>
  18     <CMDSYNOPSIS>
  19       <COMMAND>sp2sp</COMMAND>
  20       <ARG>-c <REPLACEABLE>output-format</REPLACEABLE></ARG>
  21       <ARG>-f <REPLACEABLE>fieldnamelist</REPLACEABLE></ARG>
  22       <ARG>-n <REPLACEABLE>fieldnumberlist</REPLACEABLE></ARG>
  23       <ARG>-t <REPLACEABLE>input-format</REPLACEABLE></ARG>
  24       <ARG>-v</ARG>
  25       <arg choice="plain"><REPLACEABLE>filename</REPLACEABLE></ARG>
  26     </CMDSYNOPSIS>
  27   </REFSYNOPSISDIV>
  28
  29   <REFSECT1>
  30     <TITLE>Description</TITLE>
  31     <PARA>
  32 <COMMAND>sp2sp</COMMAND>translates analog waveform data, such as that
  33 produced by <APPLICATION>spice</application>, from one format to another.
  34 Several input and output formats are supported.  In addition,
  35 a subset of the variables in the input file can be selected to appear
  36 in the output.
  37     </PARA>
  38     <PARA>
  39 If no <REPLACEABLE CLASS="PARAMETER">filename</REPLACEABLE>
  40 is specified, <command>sp2sp</command> reads from the standard input.
  41 Translated results are always sent to standard output.
  42     </PARA>
  43     <PARA>
  44 <command>sp2sp</command> accepts the following options:
  45     <VARIABLELIST>
  46         <VARLISTENTRY>
  47           <TERM>-c <REPLACEABLE>output-format</REPLACEABLE></TERM>
  48           <LISTITEM>
  49             <PARA>
  50 Sets the format for the output file.  Available formats include
  51 ascii, nohead, and cazm.
  52 </PARA>
  53           </LISTITEM>
  54         </VARLISTENTRY>
  55
  56         <VARLISTENTRY>
  57           <TERM>-f <REPLACEABLE>fieldnamelist</REPLACEABLE></term>
  58           <LISTITEM>
  59             <PARA>
  60 A list of field names, seperated by commas.  Only the fields matching the specified
  61 names are included in the output.  Field names comparisons are case-insensitive.
  62 If a field name does not match exactly, sp2sp also looks for the field name with "v("
  63 prepended, to allow for the tendancy of <application>HSpice</application> to list voltages
  64 this way in transient simulation output.
  65 </PARA>
  66           </LISTITEM>
  67         </VARLISTENTRY>
  68
  69         <VARLISTENTRY>
  70           <TERM>-n <REPLACEABLE>fieldnumberlist</REPLACEABLE></term>
  71           <LISTITEM>
  72             <PARA>
  73 A list of field numbers, seperated by commas.  The independent variable, for example
  74 the time axis of a transient simulation, is field number zero.
  75 </PARA>
  76           </LISTITEM>
  77         </VARLISTENTRY>
  78
  79         <VARLISTENTRY>
  80           <TERM>-t <REPLACEABLE>input-format</REPLACEABLE></TERM>
  81           <LISTITEM>
  82             <PARA>
  83 Sets the expected format for input file or standard input.  Input formats
  84 supported include: cazm and hspice.
  85 </PARA>
  86           </LISTITEM>
  87         </VARLISTENTRY>
  88
  89         <VARLISTENTRY>
  90           <TERM>-v</TERM>
  91           <LISTITEM>
  92             <PARA>
  93 Turns on verbose mode to print detailed information about the input file.
  94 </PARA>
  95           </LISTITEM>
  96         </VARLISTENTRY>
  97
  98       </variablelist>
  99     </para>
 100   </REFSECT1>
 101
 102   <REFSECT1>
 103     <TITLE>FILE FORMATS SUPPORTED</TITLE>
 104     <PARA>
 105 A number of file formats are supported by <command>sp2sp</command>,
 106 with more to be added in the future.   Note that some formats are
 107 only supported for input or output; this asymetry should also be corrected
 108 where possible.
 109     <VARIABLELIST>
 110         <VARLISTENTRY>
 111           <TERM>ascii</term>
 112           <LISTITEM>
 113             <PARA>
 114 A simple tabular ascii format, with column headings.  Note that files
 115 in this format may have very long lines.  Available for output only.
 116 </PARA>
 117           </LISTITEM>
 118         </VARLISTENTRY>
 119
 120         <VARLISTENTRY>
 121           <TERM>nohead</term>
 122           <LISTITEM>
 123             <PARA>
 124 Supported for output only, this format is similar to the
 125 ascii format, except that there are no column headings.
 126 This format is most useful for feeding into other unix
 127 utilities, such as awk, for specialized postprocessing.
 128 </PARA>
 129           </LISTITEM>
 130         </VARLISTENTRY>
 131
 132         <VARLISTENTRY>
 133           <TERM>cazm</term>
 134           <LISTITEM>
 135             <PARA>
 136 This format, generated by the CAzM simulator, is accepted for
 137 input and output.  It is essentialy the same as "ascii" except for its header.
 138 </PARA>
 139           </LISTITEM>
 140         </VARLISTENTRY>
 141
 142         <VARLISTENTRY>
 143           <TERM>hspice</term>
 144           <LISTITEM>
 145             <PARA>
 146 The formats produced by <application>HSpice</application>, from
 147 transient, sweep, and AC analyses are supprorted for input only.
 148 Both the ascii and binary subformats are supported for reading and
 149 are automaticly detected.
 150 </PARA>
 151           </LISTITEM>
 152         </VARLISTENTRY>
 153
 154     </VARIABLELIST>
 155     </PARA>
 156   </REFSECT1>
 157
 158   <REFSECT1>
 159     <TITLE>EXAMPLES</TITLE>
 160     <PARA>
 161     </PARA>
 162   </REFSECT1>
 163   <REFSECT1>
 164     <TITLE>BUGS</TITLE>
 165     <PARA>
 166 For input file formats that support multiple sets of waveforms in the same file,
 167 only the first one is recognized and translated.
 168     </PARA>
 169   </REFSECT1>
 170 </REFENTRY>