##// END OF EJS Templates
update whatsnew with review
MinRK -
Show More
@@ -1,577 +1,583 b''
1 =============
1 =============
2 0.13 Series
2 0.13 Series
3 =============
3 =============
4
4
5 Release 0.13
5 Release 0.13
6 ============
6 ============
7
7
8 IPython 0.13 contains several major new features, as well as a large amount of
8 IPython 0.13 contains several major new features, as well as a large amount of
9 bug and regression fixes. The previous version (0.12) was released on December
9 bug and regression fixes. The previous version (0.12) was released on December
10 19 2011, so this release cycle was roughly 6 months long, during which we
10 19 2011, so this release cycle was roughly 6 months long, during which we
11 closed a total of 373 pull requests and 742 issues, with contributions from 62
11 closed a total of 373 pull requests and 742 issues, with contributions from 62
12 authors comprising over 1740 commits.
12 authors comprising over 1740 commits.
13
13
14 The amount of work included in this release is so large, that we can only cover
14 The amount of work included in this release is so large, that we can only cover
15 here the main highlights; please see our :ref:`detailed release statistics
15 here the main highlights; please see our :ref:`detailed release statistics
16 <issues_list_013>` for links to every issue and pull request closed on github
16 <issues_list_013>` for links to every issue and pull request closed on GitHub.
17
17
18
18
19 Major Notebook improvements: new user interface and more
19 Major Notebook improvements: new user interface and more
20 --------------------------------------------------------
20 --------------------------------------------------------
21
21
22 The IPython Notebook, which has proven since its release to be wildly popular,
22 The IPython Notebook, which has proven since its release to be wildly popular,
23 has seen a massive amount of work in this release cycle, leading to a
23 has seen a massive amount of work in this release cycle, leading to a
24 significantly improved user experience as well as many new features.
24 significantly improved user experience as well as many new features.
25
25
26 The first user-visible change is a reorganization of the user interface; the
26 The first user-visible change is a reorganization of the user interface; the
27 left panel has been removed and was replaced by a real menu system and a
27 left panel has been removed and was replaced by a real menu system and a
28 toolbar with icons. Both the toolbar and the header above the menu can be
28 toolbar with icons. Both the toolbar and the header above the menu can be
29 collapsed to leave an unobstructed working area:
29 collapsed to leave an unobstructed working area:
30
30
31 .. image:: ../_static/ipy_013_notebook_spectrogram.png
31 .. image:: ../_static/ipy_013_notebook_spectrogram.png
32 :width: 400px
32 :width: 460px
33 :alt: New user interface for Notebook
33 :alt: New user interface for Notebook
34 :align: center
34 :align: center
35 :target: ../_static/ipy_013_notebook_spectrogram.png
35 :target: ../_static/ipy_013_notebook_spectrogram.png
36
36
37 The notebook handles very long outputs much better than before (this was a
37 The notebook handles very long outputs much better than before (this was a
38 serious usability issue when running processes that generated massive amounts
38 serious usability issue when running processes that generated massive amounts
39 of output). Now, in the presence of outputs longer than ~100 lines, the
39 of output). Now, in the presence of outputs longer than ~100 lines, the
40 notebook will automatically collapse to a scrollable area and the entire left
40 notebook will automatically collapse to a scrollable area and the entire left
41 part of this area controls the display: one click in this area will expand the
41 part of this area controls the display: one click in this area will expand the
42 output region completely, and a double-click will hide it completely. This
42 output region completely, and a double-click will hide it completely. This
43 figure shows both the scrolled and hidden modes:
43 figure shows both the scrolled and hidden modes:
44
44
45 .. image:: ../_static/ipy_013_notebook_long_out.png
45 .. image:: ../_static/ipy_013_notebook_long_out.png
46 :width: 400px
46 :width: 460px
47 :alt: Scrolling and hiding of long output in the notebook.
47 :alt: Scrolling and hiding of long output in the notebook.
48 :align: center
48 :align: center
49 :target: ../_static/ipy_013_notebook_long_out.png
49 :target: ../_static/ipy_013_notebook_long_out.png
50
50
51 .. note::
51 .. note::
52
52
53 The auto-folding of long outputs is disabled in Firefox due to bugs in its
53 The auto-folding of long outputs is disabled in Firefox due to bugs in its
54 scrolling behavior. See :ghpull:`2047` for details.
54 scrolling behavior. See :ghpull:`2047` for details.
55
55
56 Uploading notebooks to the dashboard is now easier: in addition to drag and
56 Uploading notebooks to the dashboard is now easier: in addition to drag and
57 drop (which can be finicky sometimes), you can now click on the upload text and
57 drop (which can be finicky sometimes), you can now click on the upload text and
58 use a regular file dialog box to select notebooks to upload. Furthermore, the
58 use a regular file dialog box to select notebooks to upload. Furthermore, the
59 notebook dashboard now auto-refreshes its contents and offers buttons to shut
59 notebook dashboard now auto-refreshes its contents and offers buttons to shut
60 down any running kernels (:ghpull:`1739`):
60 down any running kernels (:ghpull:`1739`):
61
61
62 .. image:: ../_static/ipy_013_dashboard.png
62 .. image:: ../_static/ipy_013_dashboard.png
63 :width: 400px
63 :width: 460px
64 :alt: Improved dashboard
64 :alt: Improved dashboard
65 :align: center
65 :align: center
66 :target: ../_static/ipy_013_dashboard.png
66 :target: ../_static/ipy_013_dashboard.png
67
67
68
68
69 Cluster management
69 Cluster management
70 ~~~~~~~~~~~~~~~~~~
70 ~~~~~~~~~~~~~~~~~~
71
71
72 The notebook dashboard can now also start and stop clusters, and you can
72 The notebook dashboard can now also start and stop clusters, and you can
73 override the number of engines started. There is a new tab in the dashboard
73 override the number of engines started. There is a new tab in the dashboard
74 user interface:
74 user interface:
75
75
76 .. image:: ../_static/ipy_013_dashboard_cluster.png
76 .. image:: ../_static/ipy_013_dashboard_cluster.png
77 :width: 400px
77 :width: 460px
78 :alt: Cluster management from the notebook dashboard
78 :alt: Cluster management from the notebook dashboard
79 :align: center
79 :align: center
80 :target: ../_static/ipy_013_dashboard_cluster.png
80 :target: ../_static/ipy_013_dashboard_cluster.png
81
81
82 This tab allows you, for each profile you have configured, to start and stop a
82 This tab allows you, for each profile you have configured, to start and stop a
83 cluster (and optionally override the default number of engines corresponding to
83 cluster (and optionally override the default number of engines corresponding to
84 that configuration). While this hides all error reporting, once you have a
84 that configuration). While this hides all error reporting, once you have a
85 configuration that you know works smoothly, it is a very convenient interface
85 configuration that you know works smoothly, it is a very convenient interface
86 for controlling your parallel resources.
86 for controlling your parallel resources.
87
87
88
88
89 New notebook format
89 New notebook format
90 ~~~~~~~~~~~~~~~~~~~
90 ~~~~~~~~~~~~~~~~~~~
91
91
92 The notebooks saved now use version 3 of our format, which supports heading
92 The notebooks saved now use version 3 of our format, which supports heading
93 levels as well as the concept of 'raw' text cells that are not rendered as
93 levels as well as the concept of 'raw' text cells that are not rendered as
94 Markdown. These will be useful with converters_ we are developing, to pass raw
94 Markdown. These will be useful with converters_ we are developing, to pass raw
95 markup (say LaTeX). That conversion code is still under heavy development and
95 markup (say LaTeX). That conversion code is still under heavy development and
96 not quite ready for prime time, but we welcome help on this front so that we
96 not quite ready for prime time, but we welcome help on this front so that we
97 can merge it for full production use as soon as possible.
97 can merge it for full production use as soon as possible.
98
98
99 .. _converters: https://github.com/ipython/nbconvert
99 .. _converters: https://github.com/ipython/nbconvert
100
100
101 .. note::
101 .. note::
102
102
103 v3 notebooks can *not* be read by older versions of IPython, but we provide
103 v3 notebooks can *not* be read by older versions of IPython, but we provide
104 a `simple script`__ that you can use in case you need to export a v3
104 a `simple script`_ that you can use in case you need to export a v3
105 notebook to share with a v2 user.
105 notebook to share with a v2 user.
106
106
107 .. _simple script: https://gist.github.com/1935808
107 .. _simple script: https://gist.github.com/1935808
108
108
109
109
110 JavaScript refactoring
110 JavaScript refactoring
111 ~~~~~~~~~~~~~~~~~~~~~~
111 ~~~~~~~~~~~~~~~~~~~~~~
112
112
113 All the client-side JavaScript has been decoupled to ease reuse of parts of the
113 All the client-side JavaScript has been decoupled to ease reuse of parts of the
114 machinery without having to build a full-blown notebook. This will make it much
114 machinery without having to build a full-blown notebook. This will make it much
115 easier to communicate with an IPython kernel from existing web pages and to
115 easier to communicate with an IPython kernel from existing web pages and to
116 integrate single cells into other sites, without loading the full notebook
116 integrate single cells into other sites, without loading the full notebook
117 document-like UI. :ghpull:`1711`.
117 document-like UI. :ghpull:`1711`.
118
118
119 This refactoring also enables the possibility of writing dynamic javascript
119 This refactoring also enables the possibility of writing dynamic javascript
120 widgets that are returned from Python code and that present an interactive view
120 widgets that are returned from Python code and that present an interactive view
121 to the user, with callbacks in Javascript executing calls to the Kernel. This
121 to the user, with callbacks in Javascript executing calls to the Kernel. This
122 will enable many interactive elements to be added by users in notebooks.
122 will enable many interactive elements to be added by users in notebooks.
123
123
124 An example of this capability has been provided as a proof of concept in
124 An example of this capability has been provided as a proof of concept in
125 `docs/examples/widgets` that lets you directly communicate with one or more
125 :file:`docs/examples/widgets` that lets you directly communicate with one or more
126 parallel engines, acting as a mini-console for parallel debugging and
126 parallel engines, acting as a mini-console for parallel debugging and
127 introspection.
127 introspection.
128
128
129
129
130 Improved tooltips
130 Improved tooltips
131 ~~~~~~~~~~~~~~~~~
131 ~~~~~~~~~~~~~~~~~
132
132
133 The object tooltips have gained some new functionality. By pressing tab several
133 The object tooltips have gained some new functionality. By pressing tab several
134 times, you can expand them to see more of a docstring, keep them visible as you
134 times, you can expand them to see more of a docstring, keep them visible as you
135 fill in a function's parameters, or transfer the information to the pager at the
135 fill in a function's parameters, or transfer the information to the pager at the
136 bottom of the screen. For the details, look at the example notebook
136 bottom of the screen. For the details, look at the example notebook
137 :file:`01_notebook_introduction.ipynb`.
137 :file:`01_notebook_introduction.ipynb`.
138
138
139 .. figure:: ../_static/ipy_013_notebook_tooltip.png
139 .. figure:: ../_static/ipy_013_notebook_tooltip.png
140 :width: 400px
140 :width: 460px
141 :alt: Improved tooltips in the notebook.
141 :alt: Improved tooltips in the notebook.
142 :align: center
142 :align: center
143 :target: ../_static/ipy_013_notebook_tooltip.png
143 :target: ../_static/ipy_013_notebook_tooltip.png
144
144
145 The new notebook tooltips.
145 The new notebook tooltips.
146
146
147 Other improvements to the Notebook
147 Other improvements to the Notebook
148 ----------------------------------
148 ----------------------------------
149
149
150 * The notebook pager (the area at the bottom) is now resizeable by dragging its
150 * The notebook pager (the area at the bottom) is now resizeable by dragging its
151 divider handle, a feature that had been requested many times by just about
151 divider handle, a feature that had been requested many times by just about
152 anyone who had used the notebook system. :ghpull:`1705`.
152 anyone who had used the notebook system. :ghpull:`1705`.
153
153
154 * If a notebook directory is specified with ``--notebook-dir`` (or with the
154 * If a notebook directory is specified with ``--notebook-dir`` (or with the
155 corresponding configuration flag ``NotebookManager.notebook_dir``), all
155 corresponding configuration flag ``NotebookManager.notebook_dir``), all
156 kernels start in this directory.
156 kernels start in this directory.
157
157
158 * It is now possible to open notebooks directly from the command line; for
158 * It is now possible to open notebooks directly from the command line; for
159 example: ``ipython notebook path/`` will automatically set ``path/`` as the
159 example: ``ipython notebook path/`` will automatically set ``path/`` as the
160 notebook directory, and ``ipython notebook path/foo.ipynb`` will further
160 notebook directory, and ``ipython notebook path/foo.ipynb`` will further
161 start with the ``foo.ipynb`` notebook opened. :ghpull:`1686`.
161 start with the ``foo.ipynb`` notebook opened. :ghpull:`1686`.
162
162
163 * Fix codemirror clearing of cells with ``Ctrl-Z``; :ghpull:`1965`.
163 * Fix codemirror clearing of cells with ``Ctrl-Z``; :ghpull:`1965`.
164
164
165 * Text (markdown) cells now line wrap correctly in the notebook, making them
165 * Text (markdown) cells now line wrap correctly in the notebook, making them
166 much easier to edit :ghpull:`1330`.
166 much easier to edit :ghpull:`1330`.
167
167
168 * PNG and JPEG figures returned from plots can be interactively resized in the
168 * PNG and JPEG figures returned from plots can be interactively resized in the
169 notebook, by dragging them from their lower left corner. :ghpull:`1832`.
169 notebook, by dragging them from their lower left corner. :ghpull:`1832`.
170
170
171 * Clear In[] prompt numbers on "Clear All Output". For more
171 * Clear In[] prompt numbers on "Clear All Output". For more
172 version-control-friendly `.ipynb` files, this strips the `In[]` prompt
172 version-control-friendly `.ipynb` files, this strips the `In[]` prompt
173 numbers when doing a "Clear all output". This reduces the amount of noise in
173 numbers when doing a "Clear all output". This reduces the amount of noise in
174 commit-to-commit diffs that would otherwise show the (highly variable) prompt
174 commit-to-commit diffs that would otherwise show the (highly variable) prompt
175 number changes. :ghpull:`1621`.
175 number changes. :ghpull:`1621`.
176
176
177 * The notebook server now requires *two* consecutive ``Ctrl-C`` to stop within 5
177 * The notebook server now requires *two* consecutive ``Ctrl-C`` to stop within 5
178 seconds (or an interactive confirmation). This makes it less likely that you
178 seconds (or an interactive confirmation). This makes it less likely that you
179 will accidentally kill a long-running server by typing ``Ctrl-C`` in the
179 will accidentally kill a long-running server by typing ``Ctrl-C`` in the
180 wrong terminal. :ghpull:`1609`.
180 wrong terminal. :ghpull:`1609`.
181
181
182 * Using ``Ctrl-S`` (or ``Cmd-S`` on a Mac) actually saves the notebook rather
182 * Using ``Ctrl-S`` (or ``Cmd-S`` on a Mac) actually saves the notebook rather
183 than providing the fairly useless browser html save dialog. :ghpull:`1334`.
183 than providing the fairly useless browser html save dialog. :ghpull:`1334`.
184
184
185 * Allow accessing local files from the notebook (in urls), by serving any local
185 * Allow accessing local files from the notebook (in urls), by serving any local
186 file as the url ``files/<relativepath``. This makes it possible to, for
186 file as the url ``files/<relativepath>``. This makes it possible to, for
187 example, embed local images in a notebook. :ghpull:`1211`.
187 example, embed local images in a notebook. :ghpull:`1211`.
188
188
189
189
190 Cell magics
190 Cell magics
191 -----------
191 -----------
192
192
193 We have completely refactored the magic system, finally moving the magic
193 We have completely refactored the magic system, finally moving the magic
194 objects to standalone, independent objects instead of being the mixin class
194 objects to standalone, independent objects instead of being the mixin class
195 we'd had since the beginning of IPython (:ghpull:`1732`). Now, a separate base
195 we'd had since the beginning of IPython (:ghpull:`1732`). Now, a separate base
196 class is provided in :class:`IPython.core.magic.Magics` that users can subclass
196 class is provided in :class:`IPython.core.magic.Magics` that users can subclass
197 to create their own magics. Decorators are also provided to create magics from
197 to create their own magics. Decorators are also provided to create magics from
198 simple functions without the need for object orientation.
198 simple functions without the need for object orientation.
199
199
200 All builtin magics now exist in a few subclasses that group together related
200 All builtin magics now exist in a few subclasses that group together related
201 functionality, and the new :mod:`IPython.core.magics` package has been created
201 functionality, and the new :mod:`IPython.core.magics` package has been created
202 to organize this into smaller files.
202 to organize this into smaller files.
203
203
204 This cleanup was the last major piece of deep refactoring needed from the
204 This cleanup was the last major piece of deep refactoring needed from the
205 original 2001 codebase.
205 original 2001 codebase.
206
206
207 We have also introduced a new type of magic function, prefixed with `%%`
207 We have also introduced a new type of magic function, prefixed with `%%`
208 instead of `%`, which operates at the cell level. A cell magic receives two
208 instead of `%`, which operates at the cell level. A cell magic receives two
209 arguments: the line it is called on (like a line magic) and the body of the
209 arguments: the line it is called on (like a line magic) and the body of the
210 cell below it.
210 cell below it.
211
211
212 Cell magics are most natural in the notebook, but they also work in the
212 Cell magics are most natural in the notebook, but they also work in the
213 terminal and qt console, with the usual approach of using a blank line to
213 terminal and qt console, with the usual approach of using a blank line to
214 signal cell termination.
214 signal cell termination.
215
215
216 For example, to time the execution of several statements::
216 For example, to time the execution of several statements::
217
217
218 %%timeit x = 0 # setup
218 %%timeit x = 0 # setup
219 for i in range(100000):
219 for i in range(100000):
220 x += i**2
220 x += i**2
221
221
222 This is particularly useful to integrate code in another language, and cell
222 This is particularly useful to integrate code in another language, and cell
223 magics already exist for shell scripts, Cython, R and Octave. Using ``%%script
223 magics already exist for shell scripts, Cython, R and Octave. Using ``%%script
224 /usr/bin/foo``, you can run a cell in any interpreter that accepts code via
224 /usr/bin/foo``, you can run a cell in any interpreter that accepts code via
225 stdin.
225 stdin.
226
226
227 Another handy cell magic makes it easy to write short text files: ``%%file
227 Another handy cell magic makes it easy to write short text files: ``%%file
228 ~/save/to/here.txt``.
228 ~/save/to/here.txt``.
229
229
230 The following cell magics are now included by default; all those that use
230 The following cell magics are now included by default; all those that use
231 special interpreters (Perl, Ruby, bash, etc., assume you have the requisite
231 special interpreters (Perl, Ruby, bash, etc., assume you have the requisite
232 interpreter installed):
232 interpreter installed):
233
233
234 * ``%%!``: run cell body with the underlying OS shell; this is similar to
234 * ``%%!``: run cell body with the underlying OS shell; this is similar to
235 prefixing every line in the cell with ``!``.
235 prefixing every line in the cell with ``!``.
236
236
237 * ``%%bash``: run cell body under bash.
237 * ``%%bash``: run cell body under bash.
238
238
239 * ``%%capture``: capture the output of the code in the cell (and stderr as
239 * ``%%capture``: capture the output of the code in the cell (and stderr as
240 well). Useful to run codes that produce too much output that you don't even
240 well). Useful to run codes that produce too much output that you don't even
241 want scrolled.
241 want scrolled.
242
242
243 * ``%%file``: save cell body as a file.
243 * ``%%file``: save cell body as a file.
244
244
245 * ``%%perl``: run cell body using Perl.
245 * ``%%perl``: run cell body using Perl.
246
246
247 * ``%%prun``: run cell body with profiler (cell extension of ``%prun``).
247 * ``%%prun``: run cell body with profiler (cell extension of ``%prun``).
248
248
249 * ``%%python3``: run cell body using Python 3.
249 * ``%%python3``: run cell body using Python 3.
250
250
251 * ``%%ruby``: run cell body using Ruby.
251 * ``%%ruby``: run cell body using Ruby.
252
252
253 * ``%%script``: run cell body with the script specified in the first line.
253 * ``%%script``: run cell body with the script specified in the first line.
254
254
255 * ``%%sh``: run cell body using sh.
255 * ``%%sh``: run cell body using sh.
256
256
257 * ``%%sx``: capture cell output running the code with the system shell (cell
257 * ``%%sx``: capture cell output running the code with the system shell (cell
258 extension of ``%sx``).
258 extension of ``%sx``).
259
259
260 * ``%%system``: run cell with system shell (similar to ``%%!``)
260 * ``%%system``: run cell with system shell (``%%!`` is an alias to this).
261
261
262 * ``%%timeit``: time the execution of the cell (extension of ``%timeit``).
262 * ``%%timeit``: time the execution of the cell (extension of ``%timeit``).
263
263
264 This is what some of the script-related magics look like in action:
264 This is what some of the script-related magics look like in action:
265
265
266 .. image:: ../_static/ipy_013_notebook_script_cells.png
266 .. image:: ../_static/ipy_013_notebook_script_cells.png
267 :width: 400px
267 :width: 460px
268 :alt: Cluster management from the notebook dashboard
268 :alt: Cluster management from the notebook dashboard
269 :align: center
269 :align: center
270 :target: ../_static/ipy_013_notebook_script_cells.png
270 :target: ../_static/ipy_013_notebook_script_cells.png
271
271
272 In addition, we have also a number of :ref:`extensions <extensions_overview>`
272 In addition, we have also a number of :ref:`extensions <extensions_overview>`
273 that provide specialized magics. These typically require additional software
273 that provide specialized magics. These typically require additional software
274 to run and must be manually loaded via ``%load_ext <extension name>``, but are
274 to run and must be manually loaded via ``%load_ext <extension name>``, but are
275 extremely useful. In particular, we want to highlight a few:
275 extremely useful. In particular, we want to highlight a few:
276
276
277
277
278
278
279
279
280 Tab completer improvements
280 Tab completer improvements
281 --------------------------
281 --------------------------
282
282
283 Useful tab-completion based on live inspection of objects is one of the most
283 Useful tab-completion based on live inspection of objects is one of the most
284 popular features of IPython. To make this process even more user-friendly, the
284 popular features of IPython. To make this process even more user-friendly, the
285 completers of both the Qt console and the Notebook have been reworked.
285 completers of both the Qt console and the Notebook have been reworked.
286
286
287 The Qt console comes with a new ncurses-like tab completer, activated by
287 The Qt console comes with a new ncurses-like tab completer, activated by
288 default, which lets you cycle through the available completions by pressing tab,
288 default, which lets you cycle through the available completions by pressing tab,
289 or select a completion with the arrow keys (:ghpull:`1851`).
289 or select a completion with the arrow keys (:ghpull:`1851`).
290
290
291 .. figure:: ../_static/ipy_013_qtconsole_completer.png
291 .. figure:: ../_static/ipy_013_qtconsole_completer.png
292 :width: 400px
292 :width: 460px
293 :alt: ncurses-like completer, with highlighted selection.
293 :alt: ncurses-like completer, with highlighted selection.
294 :align: center
294 :align: center
295 :target: ../_static/ipy_013_qtconsole_completer.png
295 :target: ../_static/ipy_013_qtconsole_completer.png
296
296
297 The new improved Qt console's ncurses-like completer allows to easily
297 The new improved Qt console's ncurses-like completer allows to easily
298 navigate thought long list of completions.
298 navigate thought long list of completions.
299
299
300 In the notebook, completions are now sourced both from object introspection and
300 In the notebook, completions are now sourced both from object introspection and
301 analysis of surrounding code, so limited completions can be offered for
301 analysis of surrounding code, so limited completions can be offered for
302 variables defined in the current cell, or while the kernel is busy
302 variables defined in the current cell, or while the kernel is busy
303 (:ghpull:`1711`).
303 (:ghpull:`1711`).
304
304
305
305
306 We have implemented a new configurable flag to control tab completion on
306 We have implemented a new configurable flag to control tab completion on
307 modules that provide the ``__all__`` attribute::
307 modules that provide the ``__all__`` attribute::
308
308
309 IPCompleter.limit_to__all__= Boolean.
309 IPCompleter.limit_to__all__= Boolean
310
310
311 This instructs the completer to honor ``__all__`` for the completion.
311 This instructs the completer to honor ``__all__`` for the completion.
312 Specifically, when completing on ``object.<tab>``, if True: only those names
312 Specifically, when completing on ``object.<tab>``, if True: only those names
313 in ``obj.__all__`` will be included. When False [default]: the ``__all__``
313 in ``obj.__all__`` will be included. When False [default]: the ``__all__``
314 attribute is ignored. :ghpull:`1529`.
314 attribute is ignored. :ghpull:`1529`.
315
315
316
316
317 Improvements to the Qt console
317 Improvements to the Qt console
318 ------------------------------
318 ------------------------------
319
319
320 * changes for easier integration into other projects such as Spyder_.
320 * changes for easier integration into other projects such as Spyder_.
321
321
322 .. _spyder: https://code.google.com/p/spyderlib
323
324 * Improved menus with a new Magic menu that is organized by magic groups (this
322 * Improved menus with a new Magic menu that is organized by magic groups (this
325 was made possible by the reorganization of the magic system
323 was made possible by the reorganization of the magic system
326 internals). :ghpull:`1782`.
324 internals). :ghpull:`1782`.
327
325
328 * Allow for restarting kernels without clearing the qtconsole, while leaving a
326 * Allow for restarting kernels without clearing the qtconsole, while leaving a
329 visible indication that the kernel has restarted. :ghpull:`1681`.
327 visible indication that the kernel has restarted. :ghpull:`1681`.
330
328
331 * Allow the native display of jpeg image in the qtconsole. :ghpull:`1643`.
329 * Allow the native display of jpeg image in the qtconsole. :ghpull:`1643`.
332
330
331 .. _spyder: https://code.google.com/p/spyderlib
332
333
333
334
334 Parallel
335 Parallel
335 --------
336 --------
336
337
337 The parallel tools have been improved and fine-tuned on multiple fronts. Now,
338 The parallel tools have been improved and fine-tuned on multiple fronts. Now,
338 the creation of an :class:`IPython.parallel.Client` object automatically
339 the creation of an :class:`IPython.parallel.Client` object automatically
339 activates a line and cell magic function ``px`` that sends its code to all the
340 activates a line and cell magic function ``px`` that sends its code to all the
340 engines. Further magics can be easily created with the :meth:`Client.activate`
341 engines. Further magics can be easily created with the :meth:`.Client.activate`
341 method, to conveniently execute code on any subset of engines. :ghpull:`1893`.
342 method, to conveniently execute code on any subset of engines. :ghpull:`1893`.
342
343
343 The ``%%px`` cell magic can also be given an optional targets argument, as well
344 The ``%%px`` cell magic can also be given an optional targets argument, as well
344 as a ``--out`` argument for storing its output.
345 as a ``--out`` argument for storing its output.
345
346
346 A new magic has also been added, ``%pxconfig``, that lets you configure various
347 A new magic has also been added, ``%pxconfig``, that lets you configure various
347 defaults of the parallel magics. As usual, type ``%pxconfig?`` for details.
348 defaults of the parallel magics. As usual, type ``%pxconfig?`` for details.
348
349
349 The exception reporting in parallel contexts has been improved to be easier to
350 The exception reporting in parallel contexts has been improved to be easier to
350 read. Now, IPython directly reports the remote exceptions without showing any
351 read. Now, IPython directly reports the remote exceptions without showing any
351 of the internal execution parts:
352 of the internal execution parts:
352
353
353 .. image:: ../_static/ipy_013_par_tb.png
354 .. image:: ../_static/ipy_013_par_tb.png
354 :width: 400px
355 :width: 460px
355 :alt: Improved parallel exceptions.
356 :alt: Improved parallel exceptions.
356 :align: center
357 :align: center
357 :target: ../_static/ipy_013_par_tb.png
358 :target: ../_static/ipy_013_par_tb.png
358
359
359
360
360 The parallel tools now default to using ``NoDB`` as the storage backend for
361 The parallel tools now default to using ``NoDB`` as the storage backend for
361 intermediate results. This means that the default usage case will have a
362 intermediate results. This means that the default usage case will have a
362 significantly reduced memory footprint, though certain advanced features are
363 significantly reduced memory footprint, though certain advanced features are
363 not available with this backend. For more details, see :ref:`parallel_db`.
364 not available with this backend. For more details, see :ref:`parallel_db`.
364
365
365 The parallel magics now display all output, so you can do parallel plotting or
366 The parallel magics now display all output, so you can do parallel plotting or
366 other actions with complex display. The ``px`` magic has now both line and cell
367 other actions with complex display. The ``px`` magic has now both line and cell
367 modes, and in cell mode finer control has been added about how to collate
368 modes, and in cell mode finer control has been added about how to collate
368 output from multiple engines. :ghpull:`1768`.
369 output from multiple engines. :ghpull:`1768`.
369
370
370 Incremental improvements to SSH launchers:
371 Incremental improvements to SSH launchers:
371
372
372 * add to_send/fetch steps for moving connection files around.
373 * add to_send/fetch steps for moving connection files around.
373
374
374 * add SSHProxyEngineSetLauncher, for invoking to `ipcluster engines` on a
375 * add SSHProxyEngineSetLauncher, for invoking to `ipcluster engines` on a
375 remote host. This can be used to start a set of engines via PBS/SGE/MPI
376 remote host. This can be used to start a set of engines via PBS/SGE/MPI
376 *remotely*.
377 *remotely*.
377
378
378 This makes the SSHLauncher usable on machines without shared filesystems.
379 This makes the SSHLauncher usable on machines without shared filesystems.
379
380
380 When sending files, the destination directory must *already exist* - that is,
381 When sending files, the destination directory must *already exist* - that is,
381 `ipython profile create` may be necessary on the remote system, before the
382 `ipython profile create` may be necessary on the remote system, before the
382 security dir exists for putting the connection file the first
383 security dir exists for putting the connection file the first
383 time. :ghpull:`1634`.
384 time. :ghpull:`1634`.
384
385
385 Add sugar methods/properties to AsyncResult that are generically useful
386 Add sugar methods/properties to AsyncResult that are generically useful
386 (:ghpull:`1548`):
387 (:ghpull:`1548`):
387
388
388 * ``ar.wall_time`` = received - submitted
389 * ``ar.wall_time`` = received - submitted
389 * ``ar.serial_time`` = sum of serial computation time
390 * ``ar.serial_time`` = sum of serial computation time
390 * ``ar.elapsed`` = time since submission (wall_time if done)
391 * ``ar.elapsed`` = time since submission (wall_time if done)
391 * ``ar.progress`` = (int) number of sub-tasks that have completed
392 * ``ar.progress`` = (int) number of sub-tasks that have completed
392 * ``len(ar)`` = # of tasks
393 * ``len(ar)`` = # of tasks
393 * ``ar.wait_interactive()``: prints progress
394 * ``ar.wait_interactive()``: prints progress
394
395
395 Added ``Client.spin_thread(interval)`` / ``stop_spin_thread()`` for running
396 Added :meth:`.Client.spin_thread` / :meth:`~.Client.stop_spin_thread` for running
396 spin in a background thread, to keep zmq queue clear. This can be used to
397 spin in a background thread, to keep zmq queue clear. This can be used to
397 ensure that timing information is as accurate as possible (at the cost of
398 ensure that timing information is as accurate as possible (at the cost of
398 having a background thread active).
399 having a background thread active).
399
400
400 Set TaskScheduler.hwm default to 1 instead of 0. 1 has more
401 Set TaskScheduler.hwm default to 1 instead of 0. 1 has more
401 predictable/intuitive behavior, if often slower, and thus a more logical
402 predictable/intuitive behavior, if often slower, and thus a more logical
402 default. Users whose workloads require maximum throughput and are largely
403 default. Users whose workloads require maximum throughput and are largely
403 homogeneous in time per task can make the optimization themselves, but now the
404 homogeneous in time per task can make the optimization themselves, but now the
404 behavior will be less surprising to new users. :ghpull:`1294`.
405 behavior will be less surprising to new users. :ghpull:`1294`.
405
406
406
407
407 Kernel/Engine unification
408 Kernel/Engine unification
408 -------------------------
409 -------------------------
409
410
410 :func:`IPython.parallel.bind_kernel`
411 :ghpull:`1640`
411
412
412 Add IPython.embed_kernel() as a public API.
413 Add :func:`IPython.embed_kernel()` as a public API.
413 Embedding an IPython kernel in an application is useful when you want to use
414 Embedding an IPython kernel in an application is useful when you want to use
414 IPython.embed() but don't have a terminal attached on stdin and stdout. 1640
415 IPython.embed() but don't have a terminal attached on stdin and stdout.
416
417 :func:`IPython.parallel.bind_kernel` allows you to promote Engines to listening Kernels,
418 and connect QtConsoles directly to an Engine and debug it directly.
415
419
420 This also means that Engines are now fully IPython, allowing access to magics,
421 etc. in your parallel execution.
416
422
417
423
418 Official Public API
424 Official Public API
419 -------------------
425 -------------------
420
426
421 We have begun organizing our API for easier public use, with an eye towards an
427 We have begun organizing our API for easier public use, with an eye towards an
422 official IPython 1.0 release which will firmly maintain this API compatible for
428 official IPython 1.0 release which will firmly maintain this API compatible for
423 its entire lifecycle. There is now an :mod:`IPython.display` module that
429 its entire lifecycle. There is now an :mod:`IPython.display` module that
424 aggregates all display routines, and the :mod:`IPython.config` namespace has
430 aggregates all display routines, and the :mod:`IPython.config` namespace has
425 all public configuration tools. We will continue improving our public API
431 all public configuration tools. We will continue improving our public API
426 layout so that users only need to import names one level deeper than the main
432 layout so that users only need to import names one level deeper than the main
427 ``IPython`` package to access all public namespaces.
433 ``IPython`` package to access all public namespaces.
428
434
429
435
430 IPython notebook file icons
436 IPython notebook file icons
431 ---------------------------
437 ---------------------------
432
438
433 The directory ``docs/resources`` in the source distribution contains SVG and
439 The directory ``docs/resources`` in the source distribution contains SVG and
434 PNG versions of our file icons, as well as an ``Info.plist.example`` file with
440 PNG versions of our file icons, as well as an ``Info.plist.example`` file with
435 instructions to install them on Mac OSX. This is a first draft of our icons,
441 instructions to install them on Mac OSX. This is a first draft of our icons,
436 and we encourage contributions from users with graphic talent to improve them
442 and we encourage contributions from users with graphic talent to improve them
437 in the future:
443 in the future:
438
444
439 .. image:: ../../resources/ipynb_icon_128x128.png
445 .. image:: ../../resources/ipynb_icon_128x128.png
440 :alt: IPython notebook file icon.
446 :alt: IPython notebook file icon.
441
447
442
448
443 New top-level `locate` command
449 New top-level `locate` command
444 ------------------------------
450 ------------------------------
445
451
446 Add `locate` entry points; these would be useful for quickly locating IPython
452 Add `locate` entry points; these would be useful for quickly locating IPython
447 directories and profiles from other (non-Python) applications. :ghpull:`1762`.
453 directories and profiles from other (non-Python) applications. :ghpull:`1762`.
448
454
449 Examples::
455 Examples::
450
456
451 $> ipython locate
457 $> ipython locate
452 /Users/me/.ipython
458 /Users/me/.ipython
453
459
454 $> ipython locate profile foo
460 $> ipython locate profile foo
455 /Users/me/.ipython/profile_foo
461 /Users/me/.ipython/profile_foo
456
462
457 $> ipython locate profile
463 $> ipython locate profile
458 /Users/me/.ipython/profile_default
464 /Users/me/.ipython/profile_default
459
465
460 $> ipython locate profile dne
466 $> ipython locate profile dne
461 [ProfileLocate] Profile u'dne' not found.
467 [ProfileLocate] Profile u'dne' not found.
462
468
463
469
464 Other new features and improvements
470 Other new features and improvements
465 -----------------------------------
471 -----------------------------------
466
472
467 * **%install_ext**: A new magic function to install an IPython extension from
473 * **%install_ext**: A new magic function to install an IPython extension from
468 a URL. E.g. ``%install_ext
474 a URL. E.g. ``%install_ext
469 https://bitbucket.org/birkenfeld/ipython-physics/raw/default/physics.py``.
475 https://bitbucket.org/birkenfeld/ipython-physics/raw/default/physics.py``.
470
476
471 * The ``%loadpy`` magic is no longer restricted to Python files, and has been
477 * The ``%loadpy`` magic is no longer restricted to Python files, and has been
472 renamed ``%load``. The old name remains as an alias.
478 renamed ``%load``. The old name remains as an alias.
473
479
474 * New command line arguments will help external programs find IPython folders:
480 * New command line arguments will help external programs find IPython folders:
475 ``ipython locate`` finds the user's IPython directory, and ``ipython locate
481 ``ipython locate`` finds the user's IPython directory, and ``ipython locate
476 profile foo`` finds the folder for the 'foo' profile (if it exists).
482 profile foo`` finds the folder for the 'foo' profile (if it exists).
477
483
478 * The :envvar:`IPYTHON_DIR` environment variable, introduced in the Great
484 * The :envvar:`IPYTHON_DIR` environment variable, introduced in the Great
479 Reorganization of 0.11 and existing only in versions 0.11-0.13, has been
485 Reorganization of 0.11 and existing only in versions 0.11-0.13, has been
480 deprecated. As described in :ghpull:`1167`, the complexity and confusion of
486 deprecated. As described in :ghpull:`1167`, the complexity and confusion of
481 migrating to this variable is not worth the aesthetic improvement. Please use
487 migrating to this variable is not worth the aesthetic improvement. Please use
482 the historical :envvar:`IPYTHONDIR` environment variable instead.
488 the historical :envvar:`IPYTHONDIR` environment variable instead.
483
489
484 * The default value of *interactivity* passed from
490 * The default value of *interactivity* passed from
485 :meth:`~IPython.core.interactiveshell.InteractiveShell.run_cell` to
491 :meth:`~IPython.core.interactiveshell.InteractiveShell.run_cell` to
486 :meth:`~IPython.core.interactiveshell.InteractiveShell.run_ast_nodes`
492 :meth:`~IPython.core.interactiveshell.InteractiveShell.run_ast_nodes`
487 is now configurable.
493 is now configurable.
488
494
489 * New ``%alias_magic`` function to conveniently create aliases of existing
495 * New ``%alias_magic`` function to conveniently create aliases of existing
490 magics, if you prefer to have shorter names for personal use.
496 magics, if you prefer to have shorter names for personal use.
491
497
492 * We ship unminified versions of the JavaScript libraries we use, to better
498 * We ship unminified versions of the JavaScript libraries we use, to better
493 comply with Debian's packaging policies.
499 comply with Debian's packaging policies.
494
500
495 * Simplify the information presented by ``obj?/obj??`` to eliminate a few
501 * Simplify the information presented by ``obj?/obj??`` to eliminate a few
496 redundant fields when possible. :ghpull:`2038`.
502 redundant fields when possible. :ghpull:`2038`.
497
503
498 * Improved continuous integration for IPython. We now have automated test runs
504 * Improved continuous integration for IPython. We now have automated test runs
499 on `Shining Panda <https://jenkins.shiningpanda.com/ipython>`_ and `Travis-CI
505 on `Shining Panda <https://jenkins.shiningpanda.com/ipython>`_ and `Travis-CI
500 <http://travis-ci.org/#!/ipython/ipython>`_, as well as `Tox support
506 <http://travis-ci.org/#!/ipython/ipython>`_, as well as `Tox support
501 <http://tox.testrun.org>`_.
507 <http://tox.testrun.org>`_.
502
508
503 * The `vim-ipython`_ functionality (externally developed) has been updated to
509 * The `vim-ipython`_ functionality (externally developed) has been updated to
504 the latest version.
510 the latest version.
505
511
506 .. _vim-ipython: https://github.com/ivanov/vim-ipython
512 .. _vim-ipython: https://github.com/ivanov/vim-ipython
507
513
508 * The ``%save`` magic now has a ``-f`` flag to force overwriting, which makes
514 * The ``%save`` magic now has a ``-f`` flag to force overwriting, which makes
509 it much more usable in the notebook where it is not possible to reply to
515 it much more usable in the notebook where it is not possible to reply to
510 interactive questions from the kernel. :ghpull:`1937`.
516 interactive questions from the kernel. :ghpull:`1937`.
511
517
512 * Use dvipng to format sympy.Matrix, enabling display of matrices in the Qt
518 * Use dvipng to format sympy.Matrix, enabling display of matrices in the Qt
513 console with the sympy printing extension. :ghpull:`1861`.
519 console with the sympy printing extension. :ghpull:`1861`.
514
520
515 * Our messaging protocol now has a reasonable test suite, helping ensure that
521 * Our messaging protocol now has a reasonable test suite, helping ensure that
516 we don't accidentally deviate from the spec and possibly break third-party
522 we don't accidentally deviate from the spec and possibly break third-party
517 applications that may have been using it. We encourage users to contribute
523 applications that may have been using it. We encourage users to contribute
518 more stringent tests to this part of the test suite. :ghpull:`1627`.
524 more stringent tests to this part of the test suite. :ghpull:`1627`.
519
525
520 * Use LaTeX to display, on output, various built-in types with the SymPy
526 * Use LaTeX to display, on output, various built-in types with the SymPy
521 printing extension. :ghpull:`1399`.
527 printing extension. :ghpull:`1399`.
522
528
523 * Add Gtk3 event loop integration and example. :ghpull:`1588`.
529 * Add Gtk3 event loop integration and example. :ghpull:`1588`.
524
530
525 * ``clear_output`` improvements, which allow things like progress bars and other
531 * ``clear_output`` improvements, which allow things like progress bars and other
526 simple animations to work well in the notebook (:ghpull:`1563`):
532 simple animations to work well in the notebook (:ghpull:`1563`):
527
533
528 * `clear_output()` clears the line, even in terminal IPython, the QtConsole
534 * `clear_output()` clears the line, even in terminal IPython, the QtConsole
529 and plain Python as well, by printing `\r` to streams.
535 and plain Python as well, by printing `\r` to streams.
530
536
531 * `clear_output()` avoids the flicker in the notebook by adding a delay,
537 * `clear_output()` avoids the flicker in the notebook by adding a delay,
532 and firing immediately upon the next actual display message.
538 and firing immediately upon the next actual display message.
533
539
534 * `display_javascript` hides its `output_area` element, so using display to
540 * `display_javascript` hides its `output_area` element, so using display to
535 run a bunch of javascript doesn't result in ever-growing vertical space.
541 run a bunch of javascript doesn't result in ever-growing vertical space.
536
542
537 * Add simple support for running inside a virtualenv. While this doesn't
543 * Add simple support for running inside a virtualenv. While this doesn't
538 supplant proper installation (as users should do), it helps ad-hoc calling of
544 supplant proper installation (as users should do), it helps ad-hoc calling of
539 IPython from inside a virtualenv. :ghpull:`1388`.
545 IPython from inside a virtualenv. :ghpull:`1388`.
540
546
541
547
542 Major Bugs fixed
548 Major Bugs fixed
543 ----------------
549 ----------------
544
550
545 In this cycle, we have :ref:`closed over 740 issues <issues_list_013>`, but a
551 In this cycle, we have :ref:`closed over 740 issues <issues_list_013>`, but a
546 few major ones merit special mention:
552 few major ones merit special mention:
547
553
548 * The ``%pastebin`` magic has been updated to point to gist.github.com, since
554 * The ``%pastebin`` magic has been updated to point to gist.github.com, since
549 unfortunately http://paste.pocoo.org has closed down. We also added a -d flag
555 unfortunately http://paste.pocoo.org has closed down. We also added a -d flag
550 for the user to provide a gist description string. :ghpull:`1670`.
556 for the user to provide a gist description string. :ghpull:`1670`.
551
557
552 * Fix ``%paste`` that would reject certain valid inputs. :ghpull:`1258`.
558 * Fix ``%paste`` that would reject certain valid inputs. :ghpull:`1258`.
553
559
554 * Fix sending and receiving of Numpy structured arrays (those with composite
560 * Fix sending and receiving of Numpy structured arrays (those with composite
555 dtypes, often used as recarrays). :ghpull:`2034`.
561 dtypes, often used as recarrays). :ghpull:`2034`.
556
562
557 * Reconnect when the websocket connection closes unexpectedly. :ghpull:`1577`.
563 * Reconnect when the websocket connection closes unexpectedly. :ghpull:`1577`.
558
564
559 * Fix truncated representation of objects in the debugger by showing at least
565 * Fix truncated representation of objects in the debugger by showing at least
560 80 characters' worth of information. :ghpull:`1793`.
566 80 characters' worth of information. :ghpull:`1793`.
561
567
562 * Fix logger to be Unicode-aware: logging could crash ipython if there was
568 * Fix logger to be Unicode-aware: logging could crash ipython if there was
563 unicode in the input. :ghpull:`1792`.
569 unicode in the input. :ghpull:`1792`.
564
570
565 * Fix images missing from XML/SVG export in the Qt console. :ghpull:`1449`.
571 * Fix images missing from XML/SVG export in the Qt console. :ghpull:`1449`.
566
572
567 * Fix deepreload on Python 3. :ghpull:`1625`, as well as having a much cleaner
573 * Fix deepreload on Python 3. :ghpull:`1625`, as well as having a much cleaner
568 and more robust implementation of deepreload in general. :ghpull:`1457`.
574 and more robust implementation of deepreload in general. :ghpull:`1457`.
569
575
570
576
571 Backwards incompatible changes
577 Backwards incompatible changes
572 ------------------------------
578 ------------------------------
573
579
574 * The exception :exc:`IPython.core.error.TryNext` previously accepted
580 * The exception :exc:`IPython.core.error.TryNext` previously accepted
575 arguments and keyword arguments to be passed to the next implementation
581 arguments and keyword arguments to be passed to the next implementation
576 of the hook. This feature was removed as it made error message propagation
582 of the hook. This feature was removed as it made error message propagation
577 difficult and violated the principle of loose coupling.
583 difficult and violated the principle of loose coupling.
General Comments 0
You need to be logged in to leave comments. Login now