~ubuntu-branches/ubuntu/trusty/python-gnuplot/trusty

« back to all changes in this revision

Viewing changes to doc/index.html

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2002-04-11 08:52:48 UTC
  • Revision ID: james.westby@ubuntu.com-20020411085248-r5kbl460aa2g9kdb
Tags: upstream-1.5
ImportĀ upstreamĀ versionĀ 1.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<html>
 
2
 
 
3
        <head>
 
4
        <title>Gnuplot.py</title>
 
5
        </head>
 
6
 
 
7
        <body bgcolor="#ffffff">
 
8
 
 
9
        <p><i><a href="index.html">Table of Contents</a></i></p>
 
10
        
 
11
        <table border="0" cellpadding="5" cellspacing="0" width="100%">
 
12
        <tr bgcolor="#88bbee">
 
13
            <th rowspan="2"
 
14
                valign="top"
 
15
                align="left"
 
16
                width="10%"><font color="#000000">Gnuplot.py</font>
 
17
            </th>
 
18
            <th align="right"><font color="#000000">&nbsp;</font></th>
 
19
        </tr>
 
20
        <tr>
 
21
        <td>
 
22
        <dl><dt>Gnuplot.py</dt><dd><p>A pipe-based interface to the gnuplot plotting program.</p>
 
23
 
 
24
</dd>
 
25
<dt><p><strong>The Gnuplot.py home page is</strong><p>
 
26
</dt><dd><p>    http://gnuplot-py.sourceforge.net</p>
 
27
 
 
28
 
 
29
</dd></dl>
 
30
<p>There you can get the latest version, view the documentation, or
 
31
report bugs.</p>
 
32
 
 
33
<p>Documentation
 
34
-------------</p>
 
35
 
 
36
<p>The best way to get started is to run the demo by typing `python
 
37
demo.py'.  This should pop up a few gnuplot windows, one after
 
38
another, containing simple graphs, and also write a postscript file
 
39
called `gp_test.ps' to the current directory.  Then look at the code
 
40
for the demo which is in the function `demo()' at the bottom of
 
41
demo.py.  This should be enough to get you started making simple plots
 
42
of your own.</p>
 
43
 
 
44
<p>Documentation for Gnuplot.py is in the doc/ subdirectory (which is
 
45
generated automatically from the docstrings using happydoc).  And
 
46
don't be shy, just open up the Python files with your favorite text
 
47
editor and take a look.</p>
 
48
 
 
49
<p>For a relatively thorough test of Gnuplot.py, type `python test.py'
 
50
which goes systematically through most Gnuplot.py features.</p>
 
51
 
 
52
<p>Installation
 
53
------------</p>
 
54
 
 
55
<p>Obviously, you must have the gnuplot program if Gnuplot.py is to be of
 
56
any use to you.  Gnuplot can be obtained via
 
57
<http://www.cs.dartmouth.edu/gnuplot_info.html>.  You also need
 
58
Python's Numerical extension, which is available from
 
59
<http://numpy.sourceforge.net>.</p>
 
60
 
 
61
<p>Gnuplot.py uses Python distutils
 
62
<http://www.python.org/doc/current/inst/inst.html> and can be
 
63
installed by untarring the package, changing into the top-level
 
64
directory, and typing "python setup.py install".  The Gnuplot.py
 
65
package is pure Python--no compilation is necessary.</p>
 
66
 
 
67
<p>If you want to try out the demonstration before installing the
 
68
package, type `python demo.py'.</p>
 
69
 
 
70
<p>Gnuplot.py is structured as a python package.  That means that it
 
71
installs itself as a subdirectory called `Gnuplot' under a directory
 
72
of your python path (usually site-packages).  If you don't want to use
 
73
distutils you can just move the main Gnuplot.py directory there and
 
74
rename it to "Gnuplot".</p>
 
75
 
 
76
<p>There are some configuration options that can be set near the top of
 
77
the platform-dependent files gp-unix.py (Unix), gp_mac.py (Macintosh),
 
78
and gp_win32.py (Windows).  (Obviously, you should change the file
 
79
corresponding to your platform.)  See the extensive comments in
 
80
gp_unix.py for a description of the meaning of each configuration
 
81
variable.  Sensible values are already chosen, so it is quite possible
 
82
that you don't have to change anything.</p>
 
83
 
 
84
<p>Import the main part of the package into your python programs using
 
85
`import Gnuplot'.  Some other features can be found in the modules
 
86
Gnuplot.funcutils and Gnuplot.PlotItems.</p>
 
87
 
 
88
<p>For backwards compatibility, an old function-based interface to
 
89
Gnuplot.py (derived from Konrad Hinsen's original Gnuplot.py) is
 
90
available in a separate file, oldplot.py.  However, this old interface
 
91
is deprecated and will no longer be developed.</p>
 
92
 
 
93
<p>Installation on Windows
 
94
-----------------------</p>
 
95
 
 
96
<p>I don't run Windows, but thanks to the help of users there is now a
 
97
way to use Gnuplot.py on that platform.  Any feedback or additional
 
98
suggestions having to do with Windows would be especially appreciated.</p>
 
99
 
 
100
<p>If you are using a version of Python prior to 2.0, you must install
 
101
the quasi-standard Win32 extensions.  This can be obtained from the
 
102
main Windows download page:</p>
 
103
<p>    http://www.python.org/download/download_windows.html</p>
 
104
 
 
105
 
 
106
<p>Because the main MS-Windows gnuplot executable (wgnuplot.exe) doesn't
 
107
accept commands on standard input, Gnuplot.py cannot communicate with
 
108
it directly.  However, there is a simple little program called
 
109
`pgnuplot.exe' that accepts commands on stdin and passes them to
 
110
wgnuplot.  So to run Gnuplot.py on Windows, you need to make sure that
 
111
pgnuplot.exe is installed.  It comes with gnuplot since at least
 
112
version 3.7.1.  Alternatively you can get pgnuplot.exe alone by
 
113
downloading `testing/windows-stdin.zip' from one of the gnuplot
 
114
archives (e.g.,
 
115
<ftp://ftp.gnuplot.vt.edu/pub/gnuplot/testing/windows-stdin.zip>).</p>
 
116
 
 
117
<p>Continue installing Gnuplot.py by following the instructions in the
 
118
previous section.</p>
 
119
 
 
120
<p>Installation on the Macintosh
 
121
-----------------------------</p>
 
122
 
 
123
<p>Thanks to more user help, Gnuplot.py should now work on the Macintosh
 
124
too.  Since pipes don't exist on the Mac, communication with gnuplot
 
125
is via a python module called gnuplot_Suites.py (included) which uses
 
126
AppleEvents.  Note that you will have to convert the python files to
 
127
Mac text files (different end-of-line character).  Currently it is not
 
128
possible to print directly to a printer; however, it should be
 
129
possible to print to a postscript file and print that file manually.
 
130
Also, inline data does not seem to be supported.  Let me know if you
 
131
find other problems or have patches to fix Mac limitations.</p>
 
132
 
 
133
<p>Feedback
 
134
--------</p>
 
135
 
 
136
<p>I would love to have feedback from people letting me know whether they
 
137
find Gnuplot.py useful.  And certainly let me know about any problems,
 
138
suggestions, or enhancements.  My address is at the bottom of this
 
139
file.</p>
 
140
 
 
141
<p>Gnuplot.py has been tested with gnuplot version 3.7, and I believe it
 
142
should work with version 3.5 (though some features, like enhanced
 
143
postscript mode and binary splot mode, will not work).  Let me know if
 
144
you have trouble.</p>
 
145
 
 
146
<p>Gnuplot.py was developed under Linux and Digital Unix; it should work
 
147
without much problem on other unix computers.  If you need to modify
 
148
it for your system tell me what was necessary and I'll include your
 
149
changes in a future release.</p>
 
150
 
 
151
<p>Gnuplot.py should also work under Windows and Macintosh (see above).
 
152
Feedback for these platforms is especially appreciated since I can't
 
153
test them myself.</p>
 
154
 
 
155
<p>License
 
156
-------</p>
 
157
 
 
158
<p>See the file LICENSE for license info.  Basically Gnuplot is GPL.</p>
 
159
 
 
160
<p>Credits
 
161
-------</p>
 
162
 
 
163
<p>See CREDITS.txt for a list of people who have contributed code and/or
 
164
ideas to Gnuplot.py.  Thanks especially to Konrad Hinsen
 
165
<hinsen@ibs.ibs.fr>, who wrote the first, procedural interface version
 
166
of Gnuplot.py.</p>
 
167
 
 
168
<p>--
 
169
Michael Haggerty
 
170
<mhagger@alum.mit.edu></p>
 
171
 
 
172
        
 
173
        <table border="0" cellpadding="5" cellspacing="0" width="100%%">
 
174
        
 
175
        <tr>
 
176
            <th bgcolor="#99ccff"
 
177
                rowspan="2"
 
178
                valign="top"
 
179
                align="left"
 
180
                width="20%"
 
181
                >
 
182
                <font color="#000000">
 
183
                  <a name="Modules">Modules</a>&nbsp;
 
184
                </font>
 
185
            </th>
 
186
            <th bgcolor="#99ccff"
 
187
                valign="top"
 
188
                align="left"
 
189
                >
 
190
                <font color="#000000">&nbsp;</font>
 
191
            </th>
 
192
        </tr>
 
193
        <tr>
 
194
        <td>
 
195
        <table border="0" cellpadding="5">
 
196
<tr><td valign="top" align="left"><a href="Gnuplot.html">__init__</a></td><td valign="top" align="left"><dl><dt>Gnuplot</dt><dd><p>A pipe-based interface to the gnuplot plotting program.</p>
 
197
 
 
198
</dd></dl>
 
199
</td></tr>
 
200
</table>
 
201
<h4>Gnuplot/</h4>
 
202
<table border="0" cellpadding="5">
 
203
<tr><td valign="top" align="left"><a href="Gnuplot/PlotItems.py.html">PlotItems</a></td><td valign="top" align="left"><dl><dt>PlotItems.py</dt><dd><p>Objects that can be plotted by Gnuplot.</p>
 
204
 
 
205
</dd></dl>
 
206
</td></tr>
 
207
<tr><td valign="top" align="left"><a href="Gnuplot/_Gnuplot.py.html">_Gnuplot</a></td><td valign="top" align="left"><dl><dt>_Gnuplot.py</dt><dd><p>An object that represents a running gnuplot process.</p>
 
208
 
 
209
</dd></dl>
 
210
</td></tr>
 
211
<tr><td valign="top" align="left"><a href="Gnuplot/demo.py.html">demo</a></td><td valign="top" align="left"><dl><dt>demo.py</dt><dd><p>Demonstrate the Gnuplot python module.</p>
 
212
 
 
213
</dd></dl>
 
214
</td></tr>
 
215
<tr><td valign="top" align="left"><a href="Gnuplot/funcutils.py.html">funcutils</a></td><td valign="top" align="left"><dl><dt>funcutils.py</dt><dd><p>Subroutines that tabulate a function's values.</p>
 
216
 
 
217
</dd></dl>
 
218
</td></tr>
 
219
<tr><td valign="top" align="left"><a href="Gnuplot/gnuplot_Suites.py.html">gnuplot_Suites</a></td><td valign="top" align="left"><p>Suite gnuplot Suite: Events supplied by gnuplot</p>
 
220
 
 
221
</td></tr>
 
222
<tr><td valign="top" align="left"><a href="Gnuplot/gp.py.html">gp</a></td><td valign="top" align="left"><dl><dt>gp</dt><dd><p>a platform-independent interface to a gnuplot process.</p>
 
223
 
 
224
</dd></dl>
 
225
</td></tr>
 
226
<tr><td valign="top" align="left"><a href="Gnuplot/gp_mac.py.html">gp_mac</a></td><td valign="top" align="left"><dl><dt>gp_mac</dt><dd><p>an interface to gnuplot for the Macintosh.</p>
 
227
 
 
228
</dd></dl>
 
229
</td></tr>
 
230
<tr><td valign="top" align="left"><a href="Gnuplot/gp_unix.py.html">gp_unix</a></td><td valign="top" align="left"><dl><dt>gp_unix</dt><dd><p>an interface to gnuplot used for unix platforms.</p>
 
231
 
 
232
</dd></dl>
 
233
</td></tr>
 
234
<tr><td valign="top" align="left"><a href="Gnuplot/gp_win32.py.html">gp_win32</a></td><td valign="top" align="left"><dl><dt>gp_win32</dt><dd><p>an interface to gnuplot for Windows.</p>
 
235
 
 
236
</dd></dl>
 
237
</td></tr>
 
238
<tr><td valign="top" align="left"><a href="Gnuplot/oldplot.py.html">oldplot</a></td><td valign="top" align="left"><dl><dt>oldplot.py</dt><dd><p>Obsolete functional interface to Gnuplot.</p>
 
239
 
 
240
</dd></dl>
 
241
</td></tr>
 
242
<tr><td valign="top" align="left"><a href="Gnuplot/setup.py.html">setup</a></td><td valign="top" align="left"><p>Setup script for the Gnuplot module distribution.</p>
 
243
 
 
244
</td></tr>
 
245
<tr><td valign="top" align="left"><a href="Gnuplot/test.py.html">test</a></td><td valign="top" align="left"><dl><dt>test.py</dt><dd><p>Exercise the Gnuplot.py module.</p>
 
246
 
 
247
</dd></dl>
 
248
</td></tr>
 
249
<tr><td valign="top" align="left"><a href="Gnuplot/utils.py.html">utils</a></td><td valign="top" align="left"><dl><dt>utils.py</dt><dd><p>Utility functions used by Gnuplot.</p>
 
250
 
 
251
</dd></dl>
 
252
</td></tr>
 
253
</table>
 
254
 
 
255
        </td>
 
256
        </tr>
 
257
        </table>
 
258
        
 
259
        </td>
 
260
        </tr>
 
261
        </table>
 
262
 
 
263
        <hr>
 
264
 
 
265
        <p><i><a href="index.html">Table of Contents</a></i></p>
 
266
 
 
267
        <i>This document was automatically generated on Fri Jan 26 14:06:11 2001
 
268
        by <a href="http://happydoc.sourceforge.net">HappyDoc</a> version r0_9_2</i>
 
269
 
 
270
        </body>
 
271
        </html>
 
272
        
 
 
b'\\ No newline at end of file'