1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
|
# $Id: xsil2graphics.pod 1510 2007-08-17 09:26:16Z paultcochrane $
=head1 NAME
xsil2graphics - generate scripts to load xsil output data files
=head1 SYNOPSIS
xsil2graphics [options] <xsil_file>
=head1 DESCRIPTION
Utility program bundled with B<xmds>, used to generate scripts that load
simulation output data into either matlab (http://www.mathworks.com), octave (http://www.octave.org) or
scilab (http://www.scilab.org), which are then used to manipulate the
results further if necessary and then to present the results graphically.
=head2 Matlab
To generate a matlab m-file, from the xsil file data_file.xsil use the command:
B<bash$> xsil2graphics data_file.xsil
or
B<bash$> xsil2graphics --matlab data_file.xsil
Then at the matlab or octave command prompt:
>> data_file
=head2 Scilab
To generate a scilab script file, from the xsil file data_file.xsil use the command:
B<bash$> xsil2graphics --scilab data_file.xsil
Then at the scilab command prompt:
--> exec('data_file.sci')
=head1 OPTIONS
B<-m>, B<--matlab> generate matlab or octave m-file script to load data from the xsil
data file (the default option)
B<-s>, B<-scilab> generate scilab script file to load data from the xsil
data file
B<-o>, B<--outfile <out_file>> specify an alternative output script filename to the default
which is the input xsil filename with the .xsil extension changed to either
.m for the matlab or octave m-file or .sci for the scilab script file
=head1 EXAMPLES
B<bash$> xsil2graphics nlse.xsil
Generates the output B<nlse.m> to load the data into matlab or octave
B<bash$> xsil2graphics -m nlse.xsil
Also generates the output B<nlse.m> but explicitly sets matlab to be the
output format
B<bash$> xsil2graphics --scilab nlse.xsil
Generates the output B<nlse.sci> to load the data into scilab
B<bash$> xsil2graphics --outfile nlse_new.m nlse.xsil
Generates the output B<nlse_new.m> to load the data into matlab or octave
=head1 AUTHORS
Originally written by Greg Collecutt
Maintained by Paul Cochrane with code contributed by Joe Hope
=head1 BUGS
No known bugs.
=head1 SEE ALSO
xmds(1), loadxsil(1)
http://www.xmds.org
=head1 COPYRIGHT
Copyright (C) 2000-2004
Code contributed by Greg Collecutt, Joseph Hope and Paul Cochrane
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston,
MA 02111-1307, USA.
|