-
-
Notifications
You must be signed in to change notification settings - Fork 16
Expand file tree
/
Copy pathdocumentation.html
More file actions
347 lines (302 loc) · 16.7 KB
/
documentation.html
File metadata and controls
347 lines (302 loc) · 16.7 KB
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<script type="text/javascript">
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-38683231-1', 'auto');
ga('send', 'pageview');
</script>
<title>Documentation — IPython</title>
<link rel="stylesheet" href="_static/agogo.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/ipython.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="top" title="IPython" href="index.html" />
<link rel="next" title="Support IPython Development" href="donate.html" />
<link rel="prev" title="Citing IPython" href="citing.html" />
</head>
<body>
<div class="header-wrapper">
<div class="header">
<div class="logo"><a href="index.html">
<img class="logo" src="_static/IPy_header.png" alt="Logo"/>
</a></div>
<div class="rel">
<a href="install.html">Install</a> ·
<a href="#">Docs</a> ·
<a href="videos.html">Videos</a> ·
<a href="news.html">News</a> ·
<a href="citing.html">Cite</a> ·
<a href="sponsors.html">Sponsors</a> ·
<a href="donate.html">Donate</a>
</div>
</div>
</div>
<div class="content-wrapper">
<div class="content">
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div class="sidebarblock">
<div id="cse-search-form" style="width: 100%;">Loading</div>
<script src="http://www.google.co.uk/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function() {
var customSearchControl = new google.search.CustomSearchControl(
'017950022472296044740:wfr9nyfshwo');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
var options = new google.search.DrawOptions();
options.enableSearchboxOnly("searchresults.html");
customSearchControl.draw('cse-search-form', options);
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" /> <style type="text/css">
input.gsc-input {
border-color: #BCCDF0;
}
input.gsc-search-button {
border-color: #666666;
background-color: #CECECE;
padding: 0;
}
div.sphinxsidebar input[type="text"] {
width: 100%;
}
div.sphinxsidebar input[type="submit"] {
width: 100%;
}
</style>
</div>
<div class="sidebarblock">
<h3>Versions</h3>
<div class="tile"><h4>Stable</h4>
2.3 – October 2014<br/>
<a href="install.html">Install</a>
</div>
<div class="tile"><h4>Development</h4>
3.0.dev<br/>
<a href="https://github.com/ipython/ipython">GitHub</a>
</div>
<div class="tile"><h4>Offline Docs</h4>
All Versions<br/>
<a href="https://github.com/ipython/ipython-doc/tree/gh-pages">GitHub</a>
</div>
</div>
<script type="text/javascript">
(function() {
var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true;
po.src = 'https://apis.google.com/js/plusone.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s);
})();
</script>
<div class="sidebarblock">
<h3>Notebook Viewer</h3>
Share your notebooks
<div class="nbviewer-thm-random">
<script src="_static/nbviewer_thm.js"></script>
<script type="text/javascript">
nbviewer_random_thumbnail();
</script>
</div>
</div>
<div class="sidebarblock">
<h3>Community</h3>
<ul class="simple">
<li><a class="reference external" href="https://gitter.im/ipython/ipython/help">
Help Chat Room</a></li>
<li><a class="reference external" href="http://stackoverflow.com/questions/tagged/ipython">
Stack Overflow</a></li>
<li><a class="reference external" href="http://projects.scipy.org/mailman/listinfo/ipython-dev">
Mailing list</a></li>
<li><a class="reference external" href="https://github.com/ipython/ipython/wiki">Wiki</a></li>
<li><a class="reference external" href="http://www.reddit.com/r/IPython">
Reddit</a></li>
<li><a class="reference external" href="https://github.com/ipython/ipython/issues">
File a bug</a></li>
</ul>
<div style="margin-top:10px"> <!-- sharing buttons -->
<!-- twitter -->
<a href="https://twitter.com/share" class="twitter-share-button" data-url="http://ipython.org" data-text="IPython - interactive computing." data-via="ipythondev" data-hashtags="ipython" data-dnt="true">Tweet</a>
<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
<!-- google+ -->
<g:plusone size="medium" annotation="none"></g:plusone>
</div><!-- sharing buttons -->
</div>
<div class="sidebarblock">
<h3>Book</h3>
<a href="books.html"><img
title="Packt Publishing donates a portion of the proceeds from this book to
support IPython's development." width="160" height="200" id="sidebar-book-cover"
style="margin-bottom: 10px;"></a>
<script language="javascript">
window.onload = function() {
var x = Math.random();
var img;
if (x < 0.333) {
url = "_static/ipython-book.jpg";
}
else {
url = "_static/ipython-cookbook.jpg";
}
$("#sidebar-book-cover").attr("src", url);
}
</script>
</div>
<div class="sidebarblock">
<h3>For developers</h3>
<ul class="simple">
<li><a class="reference external" href="https://gitter.im/ipython/ipython">
Development Chat Room</a></li>
<li><a class="reference external"
href="https://github.com/ipython/ipython/wiki/Dev:-Index">Development information</a></li>
<li><a class="reference external" href="https://jenkins.shiningpanda.com/ipython/">
Shining Panda</a></li>
<li><a class="reference external" href="http://travis-ci.org/#!/ipython/ipython">
Travis CI</a></li>
</ul>
</div>
<div class="sidebarblock">
<div class="tile" id="donate">
<h4>Support IPython</h4>
<center>
<form action="https://www.paypal.com/cgi-bin/webscr" method="post">
<input type="hidden" name="cmd" value="_s-xclick">
<input type="hidden" name="hosted_button_id" value="SMCAHLP2ST42G">
<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!">
<img alt="" border="0" src="https://www.paypalobjects.com/en_US/i/scr/pixel.gif" width="1" height="1">
</form>
</center>
<a href="donate.html">Find out more...</a>
</div>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="documentation">
<h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h1>
<div class="section" id="ipython-manual">
<h2>IPython manual<a class="headerlink" href="#ipython-manual" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><a class="reference external" href="http://ipython.org/ipython-doc/stable/index.html">Current Stable Version (2.x)</a></li>
<li><a class="reference external" href="http://ipython.org/ipython-doc/dev/index.html">Current Development Version</a></li>
</ul>
<p>You can download IPython documentation for offline use, and for all version of IPython on
<cite>GitHub <https://github.com/ipython/ipython-doc/tree/gh-pages></cite>.</p>
<p><a class="reference external" href="http://ipython.org/ipython-doc/stable/interactive/tutorial.html">This introduction to some key features</a> is a good
place to start if you haven’t used IPython before.</p>
<p>See <a class="reference internal" href="#docs-all-releases">below</a> for links to all versions of the documentation.</p>
</div>
<div class="section" id="other-useful-documentation">
<h2>Other useful documentation<a class="headerlink" href="#other-useful-documentation" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><a class="reference external" href="presentation.html">Presentations</a> we’ve
given at various venues regarding IPython over the years.</li>
<li><a class="reference external" href="videos.html">Videos and screencasts</a>.</li>
<li>IPython <a class="reference external" href="screenshots/index.html">screenshots</a>.</li>
<li><a class="reference external" href="https://damontallen.github.io/IPython-quick-ref-sheets/">IPython quick reference card</a>.</li>
<li>An <a class="reference external" href="http://fperez.org/papers/ipython07_pe-gr_cise.pdf">article about IPython</a>, written by Fernando
Perez and Brian Granger, published in the <a class="reference external" href="http://scitation.aip.org/content/aip/journal/cise/9/3">May/June 2007 issue</a> of
the journal <em>Computing in Science and Engineering</em>.</li>
</ul>
</div>
<div class="section" id="external-documentation-related-presentations-and-tutorials">
<h2>External documentation, related presentations and tutorials<a class="headerlink" href="#external-documentation-related-presentations-and-tutorials" title="Permalink to this headline">¶</a></h2>
<p>This is a collection of presentations, often by authors outside of the core
IPython team. Some are focused on aspects of IPython itself while others may be
about external projects that use IPython as a key component. If you have any
material that fits this description, please contact the IPython team and let us
know about it so we can post it here.</p>
<ul class="simple">
<li>The <a class="reference external" href="http://bci2000.org/downloads/BCPy2000/About.html">BCPy2000 project</a>
offers Python tools for Brain-Computer interface development, and it uses
IPython in a really neat way to enable interactive debugging of all the
components as they operate in real-time. <a class="reference external" href="http://videolectures.net/mloss08_hill_bcpy/">This talk</a> presented at the 2008 NIPS
conference shows the system.</li>
<li><a class="reference external" href="http://www.osc.edu/~unpingco">Jose Unpingco</a> made this really neat
<a class="reference external" href="http://www.osc.edu/~unpingco/Tutorial_11Dec.html">screencast</a> showing how
to couple IPython’s parallel capabilities with the <a class="reference external" href="http://mgltools.scripps.edu">Vision</a> environment. Vision is an extremely
impressive visual programming environment developed by <a class="reference external" href="http://www.scripps.edu/sanner">Michel Sanner’s</a> team at the Scripps Institute in La Jolla,
CA.</li>
<li>An <a class="reference external" href="http://magazine.redhat.com/2008/02/07/python-for-bash-scripters-a-well-kept-secret/">article</a>
by Noah Gift on RedHat Magazine that covers using Python, and IPython, as a
better Bash.</li>
<li>An <a class="reference external" href="https://www.ibm.com/developerworks/aix/library/au-netsnmpnipython">article</a> by Noah
Gift at the IBM Developer Works site, on using the Net-SNMP library to
interactively explore and manage a network (the interactive part courtesy of
IPython, of course).</li>
<li>A <a class="reference external" href="http://blog.boucault.net/post/2007/12/10/IPython-and-Pigment-simplicity">post and video</a>
about using IPython’s GTK support to interactively control a <a class="reference external" href="https://code.fluendo.com/pigment/trac">Pigment</a> application. It also uses the
IPython demo class.</li>
<li>An <a class="reference external" href="http://archive09.linux.com/feature/47635">article</a> at Linux.com about
IPython, by Conrad Koziol.</li>
<li>An <a class="reference external" href="http://www.onlamp.com/pub/a/python/2005/01/27/ipython.html">article</a> by
Jeremy Jones at ONLamp.com, introducing IPython to new users and giving a
tour of its features as a replacement for the default Python shell.</li>
<li>The O’Reilly book <a class="reference external" href="http://shop.oreilly.com/product/9780596515829.do">“Python for Unix and Linux System Administration”</a> has a chapter (the first, and
largest one) on IPython. IPython is also used throughout the book to
illustrate other Python technologies.</li>
</ul>
</div>
<div class="section" id="other-projects-using-ipython">
<h2>Other projects using IPython<a class="headerlink" href="#other-projects-using-ipython" title="Permalink to this headline">¶</a></h2>
<p><a class="reference external" href="https://github.com/ipython/ipython/wiki/Projects-using-IPython">Here</a> you can
find a list of projects that use IPython in one form or another. If you use
IPython as part of a project, please do add your information to this page or
email <a class="reference external" href="mailto:Fernando.Perez%40Berkeley.edu">Fernando<span>.</span>Perez<span>@</span>Berkeley<span>.</span>edu</a> and
I’ll be happy to add it. Also, if your project is of academic relevance,
please <a class="reference external" href="citing.html">provide a citation to IPython</a>.</p>
</div>
<div class="section" id="docs-for-all-releases">
<span id="docs-all-releases"></span><h2>Docs for all releases<a class="headerlink" href="#docs-for-all-releases" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><a class="reference external" href="http://ipython.org/ipython-doc/2/index.html">2.x</a></li>
<li><a class="reference external" href="http://ipython.org/ipython-doc/1/index.html">1.x</a></li>
<li><a class="reference external" href="http://ipython.org/ipython-doc/rel-0.13.2/index.html">0.13.2</a></li>
<li><a class="reference external" href="http://ipython.org/ipython-doc/rel-0.13.1/index.html">0.13.1</a></li>
<li><a class="reference external" href="http://ipython.org/ipython-doc/rel-0.13/index.html">0.13</a></li>
<li><a class="reference external" href="http://ipython.org/ipython-doc/rel-0.12.1/index.html">0.12.1</a></li>
<li><a class="reference external" href="http://ipython.org/ipython-doc/rel-0.12/index.html">0.12</a></li>
<li>0.11: <a class="reference external" href="http://ipython.org/ipython-doc/rel-0.11/index.html">HTML</a> and <a class="reference external" href="http://ipython.org/ipython-doc/rel-0.11/ipython.pdf">PDF</a>.</li>
<li>0.10.2: <a class="reference external" href="http://ipython.org/ipython-doc/rel-0.10.2/html">HTML</a> and <a class="reference external" href="http://ipython.org/ipython-doc/rel-0.10.2/ipython.pdf">PDF</a>.</li>
<li>0.10.1: <a class="reference external" href="http://ipython.org/ipython-doc/rel-0.10.1/html">HTML</a> and <a class="reference external" href="http://ipython.org/ipython-doc/rel-0.10.1/ipython.pdf">PDF</a>.</li>
<li>0.10: <a class="reference external" href="http://ipython.org/ipython-doc/rel-0.10/html">HTML</a> and <a class="reference external" href="http://ipython.org/ipython-doc/rel-0.10/ipython.pdf">PDF</a>.</li>
<li>0.9.1: <a class="reference external" href="http://ipython.org/ipython-doc/rel-0.9.1/html">HTML</a> and <a class="reference external" href="http://ipython.org/ipython-doc/rel-0.9.1/ipython.pdf">PDF</a>.</li>
<li>0.9: <a class="reference external" href="http://ipython.org/ipython-doc/rel-0.9/html">HTML</a> and <a class="reference external" href="http://ipython.org/ipython-doc/rel-0.9/ipython.pdf">PDF</a>.</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
<div class="footer-wrapper">
<div class="footer">
© Copyright the IPython development team.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div>
</div>
</body>
</html>