##// END OF EJS Templates
Final doc fixes for release 0.13.
Fernando Perez -
Show More
1 NO CONTENT: modified file, binary diff hidden
NO CONTENT: modified file, binary diff hidden
1 NO CONTENT: modified file, binary diff hidden
NO CONTENT: modified file, binary diff hidden
@@ -75,9 +75,8 b' down any running kernels (:ghpull:`1739`):'
75 Cluster management
75 Cluster management
76 ~~~~~~~~~~~~~~~~~~
76 ~~~~~~~~~~~~~~~~~~
77
77
78 The notebook dashboard can now also start and stop clusters, and you can
78 The notebook dashboard can now also start and stop clusters, thansk to a new
79 override the number of engines started. There is a new tab in the dashboard
79 tab in the dashboard user interface:
80 user interface:
81
80
82 .. image:: ../_static/ipy_013_dashboard_cluster.png
81 .. image:: ../_static/ipy_013_dashboard_cluster.png
83 :width: 460px
82 :width: 460px
@@ -85,9 +84,9 b' user interface:'
85 :align: center
84 :align: center
86 :target: ../_static/ipy_013_dashboard_cluster.png
85 :target: ../_static/ipy_013_dashboard_cluster.png
87
86
88 This tab allows you, for each profile you have configured, to start and stop a
87 This interface allows, for each profile you have configured, to start and stop
89 cluster (and optionally override the default number of engines corresponding to
88 a cluster (and optionally override the default number of engines corresponding
90 that configuration). While this hides all error reporting, once you have a
89 to that configuration). While this hides all error reporting, once you have a
91 configuration that you know works smoothly, it is a very convenient interface
90 configuration that you know works smoothly, it is a very convenient interface
92 for controlling your parallel resources.
91 for controlling your parallel resources.
93
92
@@ -153,19 +152,22 b' bottom of the screen. For the details, look at the example notebook'
153 Other improvements to the Notebook
152 Other improvements to the Notebook
154 ----------------------------------
153 ----------------------------------
155
154
155 These are some other notable small improvements to the notebook, in addition to
156 many bug fixes and minor changes to add polish and robustness throughout:
157
156 * The notebook pager (the area at the bottom) is now resizeable by dragging its
158 * The notebook pager (the area at the bottom) is now resizeable by dragging its
157 divider handle, a feature that had been requested many times by just about
159 divider handle, a feature that had been requested many times by just about
158 anyone who had used the notebook system. :ghpull:`1705`.
160 anyone who had used the notebook system. :ghpull:`1705`.
159
161
160 * If a notebook directory is specified with ``--notebook-dir`` (or with the
161 corresponding configuration flag ``NotebookManager.notebook_dir``), all
162 kernels start in this directory.
163
164 * It is now possible to open notebooks directly from the command line; for
162 * It is now possible to open notebooks directly from the command line; for
165 example: ``ipython notebook path/`` will automatically set ``path/`` as the
163 example: ``ipython notebook path/`` will automatically set ``path/`` as the
166 notebook directory, and ``ipython notebook path/foo.ipynb`` will further
164 notebook directory, and ``ipython notebook path/foo.ipynb`` will further
167 start with the ``foo.ipynb`` notebook opened. :ghpull:`1686`.
165 start with the ``foo.ipynb`` notebook opened. :ghpull:`1686`.
168
166
167 * If a notebook directory is specified with ``--notebook-dir`` (or with the
168 corresponding configuration flag ``NotebookManager.notebook_dir``), all
169 kernels start in this directory.
170
169 * Fix codemirror clearing of cells with ``Ctrl-Z``; :ghpull:`1965`.
171 * Fix codemirror clearing of cells with ``Ctrl-Z``; :ghpull:`1965`.
170
172
171 * Text (markdown) cells now line wrap correctly in the notebook, making them
173 * Text (markdown) cells now line wrap correctly in the notebook, making them
@@ -174,16 +176,16 b' Other improvements to the Notebook'
174 * PNG and JPEG figures returned from plots can be interactively resized in the
176 * PNG and JPEG figures returned from plots can be interactively resized in the
175 notebook, by dragging them from their lower left corner. :ghpull:`1832`.
177 notebook, by dragging them from their lower left corner. :ghpull:`1832`.
176
178
177 * Clear In[] prompt numbers on "Clear All Output". For more
179 * Clear ``In []`` prompt numbers on "Clear All Output". For more
178 version-control-friendly `.ipynb` files, this strips the `In[]` prompt
180 version-control-friendly ``.ipynb`` files, we now strip all prompt numbers
179 numbers when doing a "Clear all output". This reduces the amount of noise in
181 when doing a "Clear all output". This reduces the amount of noise in
180 commit-to-commit diffs that would otherwise show the (highly variable) prompt
182 commit-to-commit diffs that would otherwise show the (highly variable) prompt
181 number changes. :ghpull:`1621`.
183 number changes. :ghpull:`1621`.
182
184
183 * The notebook server now requires *two* consecutive ``Ctrl-C`` to stop within 5
185 * The notebook server now requires *two* consecutive ``Ctrl-C`` within 5
184 seconds (or an interactive confirmation). This makes it less likely that you
186 seconds (or an interactive confirmation) to terminate operation. This makes
185 will accidentally kill a long-running server by typing ``Ctrl-C`` in the
187 it less likely that you will accidentally kill a long-running server by
186 wrong terminal. :ghpull:`1609`.
188 typing ``Ctrl-C`` in the wrong terminal. :ghpull:`1609`.
187
189
188 * Using ``Ctrl-S`` (or ``Cmd-S`` on a Mac) actually saves the notebook rather
190 * Using ``Ctrl-S`` (or ``Cmd-S`` on a Mac) actually saves the notebook rather
189 than providing the fairly useless browser html save dialog. :ghpull:`1334`.
191 than providing the fairly useless browser html save dialog. :ghpull:`1334`.
@@ -201,7 +203,8 b' objects to standalone, independent objects instead of being the mixin class'
201 we'd had since the beginning of IPython (:ghpull:`1732`). Now, a separate base
203 we'd had since the beginning of IPython (:ghpull:`1732`). Now, a separate base
202 class is provided in :class:`IPython.core.magic.Magics` that users can subclass
204 class is provided in :class:`IPython.core.magic.Magics` that users can subclass
203 to create their own magics. Decorators are also provided to create magics from
205 to create their own magics. Decorators are also provided to create magics from
204 simple functions without the need for object orientation.
206 simple functions without the need for object orientation. Please see the
207 :ref:`magic` docs for further details.
205
208
206 All builtin magics now exist in a few subclasses that group together related
209 All builtin magics now exist in a few subclasses that group together related
207 functionality, and the new :mod:`IPython.core.magics` package has been created
210 functionality, and the new :mod:`IPython.core.magics` package has been created
@@ -260,7 +263,7 b' interpreter installed):'
260
263
261 * ``%%sh``: run cell body using sh.
264 * ``%%sh``: run cell body using sh.
262
265
263 * ``%%sx``: capture cell output running the code with the system shell (cell
266 * ``%%sx``: run cell with system shell and capture process output (cell
264 extension of ``%sx``).
267 extension of ``%sx``).
265
268
266 * ``%%system``: run cell with system shell (``%%!`` is an alias to this).
269 * ``%%system``: run cell with system shell (``%%!`` is an alias to this).
@@ -280,7 +283,7 b' that provide specialized magics. These typically require additional software'
280 to run and must be manually loaded via ``%load_ext <extension name>``, but are
283 to run and must be manually loaded via ``%load_ext <extension name>``, but are
281 extremely useful. The following extensions are provided:
284 extremely useful. The following extensions are provided:
282
285
283 **Cython magics (extension :ref:`cythonmagic <extensions_cythonmagic>`)**
286 **Cython magics** (extension :ref:`cythonmagic <extensions_cythonmagic>`)
284 This extension provides magics to automatically build and compile Python
287 This extension provides magics to automatically build and compile Python
285 extension modules using the Cython_ language. You must install Cython
288 extension modules using the Cython_ language. You must install Cython
286 separately, as well as a C compiler, for this to work. The examples
289 separately, as well as a C compiler, for this to work. The examples
@@ -295,7 +298,7 b' extremely useful. The following extensions are provided:'
295
298
296 .. _cython: http://cython.org
299 .. _cython: http://cython.org
297
300
298 **Octave magics (extension :ref:`octavemagic <extensions_octavemagic>`)**
301 **Octave magics** (extension :ref:`octavemagic <extensions_octavemagic>`)
299 This extension provides several magics that support calling code written in
302 This extension provides several magics that support calling code written in
300 the Octave_ language for numerical computing. You can execute single-lines
303 the Octave_ language for numerical computing. You can execute single-lines
301 or whole blocks of Octave code, capture both output and figures inline
304 or whole blocks of Octave code, capture both output and figures inline
@@ -315,7 +318,7 b' extremely useful. The following extensions are provided:'
315 .. _oct2py: http://pypi.python.org/pypi/oct2py
318 .. _oct2py: http://pypi.python.org/pypi/oct2py
316 .. _h5py: http://code.google.com/p/h5py
319 .. _h5py: http://code.google.com/p/h5py
317
320
318 **R magics (extension :ref:`rmagic <extensions_rmagic>`)**
321 **R magics** (extension :ref:`rmagic <extensions_rmagic>`)
319 This extension provides several magics that support calling code written in
322 This extension provides several magics that support calling code written in
320 the R_ language for statistical data analysis. You can execute
323 the R_ language for statistical data analysis. You can execute
321 single-lines or whole blocks of R code, capture both output and figures
324 single-lines or whole blocks of R code, capture both output and figures
@@ -467,20 +470,20 b' Kernel/Engine unification'
467
470
468 This is mostly work 'under the hood', but it is actually a *major* achievement
471 This is mostly work 'under the hood', but it is actually a *major* achievement
469 for the project that has deep implications in the long term: at last, we have
472 for the project that has deep implications in the long term: at last, we have
470 unified the main object that execute as the user's interactive shell (which
473 unified the main object that executes as the user's interactive shell (which we
471 we refer to as the *IPython kernel*) with the objects that run in all the
474 refer to as the *IPython kernel*) with the objects that run in all the worker
472 worker nodes of the parallel computing facilities (the *IPython engines*).
475 nodes of the parallel computing facilities (the *IPython engines*). Ever since
473 Ever since the first implementation of IPython's parallel code back in 2006, we
476 the first implementation of IPython's parallel code back in 2006, we had wanted
474 had wanted to have these two roles be played by the same machinery, but a
477 to have these two roles be played by the same machinery, but a number of
475 number of technical reasons had prevented that from being true.
478 technical reasons had prevented that from being true.
476
479
477 In this release we have now merged them, and this has a number of important
480 In this release we have now merged them, and this has a number of important
478 consequences:
481 consequences:
479
482
480 * It is possible to connect any of our clients (qtconsole or terminal console)
483 * It is now possible to connect any of our clients (qtconsole or terminal
481 to any individual parallel engine, with the *exact* behavior of working at a
484 console) to any individual parallel engine, with the *exact* behavior of
482 'regular' IPython console/qtconsole. This makes debugging, plotting, etc. in
485 working at a 'regular' IPython console/qtconsole. This makes debugging,
483 parallel scenarios vastly easier.
486 plotting, etc. in parallel scenarios vastly easier.
484
487
485 * Parallel engines can always execute arbitrary 'IPython code', that is, code
488 * Parallel engines can always execute arbitrary 'IPython code', that is, code
486 that has magics, shell extensions, etc. In combination with the ``%%px``
489 that has magics, shell extensions, etc. In combination with the ``%%px``
General Comments 0
You need to be logged in to leave comments. Login now