Show More
@@ -28,7 +28,7 b' The IPython Notebook combines two components:' | |||||
28 | Since the similarity in names can lead to some confusion, in the documentation we will use capitalization of the word "notebook" to distinguish the *N*otebook app and *n*otebook documents, thinking of the Notebook app as being a proper noun. We will also always refer to the "Notebook app" when we are referring to the browser-based interface, and usually to "notebook documents", instead of "notebooks", for added precision. |
|
28 | Since the similarity in names can lead to some confusion, in the documentation we will use capitalization of the word "notebook" to distinguish the *N*otebook app and *n*otebook documents, thinking of the Notebook app as being a proper noun. We will also always refer to the "Notebook app" when we are referring to the browser-based interface, and usually to "notebook documents", instead of "notebooks", for added precision. | |
29 |
|
29 | |||
30 | We refer to the current state of the computational process taking place in the Notebook app, i.e. the (numbered) sequence of input and output cells, as the |
|
30 | We refer to the current state of the computational process taking place in the Notebook app, i.e. the (numbered) sequence of input and output cells, as the | |
31 | *notebook space*. Notebook documents provide an *exact*, *one-to-one* record of all the content in the notebook space, as a plain text file in JSON format. The Notebook app automatically saves, at certain intervals, the contents of the notebook space to a notebook document stored on disk, with the same name as the title of the notebook space, and the file extension ``.ipynb`. For this reason, there is no confusion about using the same word "notebook" for both the notebook space and the corresonding notebook document, since they are really one and the same concept (we could say that they are "isomorphic"). |
|
31 | *notebook space*. Notebook documents provide an *exact*, *one-to-one* record of all the content in the notebook space, as a plain text file in JSON format. The Notebook app automatically saves, at certain intervals, the contents of the notebook space to a notebook document stored on disk, with the same name as the title of the notebook space, and the file extension ``.ipynb``. For this reason, there is no confusion about using the same word "notebook" for both the notebook space and the corresonding notebook document, since they are really one and the same concept (we could say that they are "isomorphic"). | |
32 |
|
32 | |||
33 |
|
33 | |||
34 | Main features of the IPython Notebook web app |
|
34 | Main features of the IPython Notebook web app | |
@@ -61,7 +61,7 b' Furthermore, any publicly available notebook may be shared via the' | |||||
61 | `IPython Notebook Viewer <http://nbviewer.ipython.org>`_ service, which will |
|
61 | `IPython Notebook Viewer <http://nbviewer.ipython.org>`_ service, which will | |
62 | provide it as a static web page. The results may thus be shared without having to install anything. |
|
62 | provide it as a static web page. The results may thus be shared without having to install anything. | |
63 |
|
63 | |||
64 |
See :ref:` |
|
64 | See the :ref:`installation documentation <install_index>` for directions on | |
65 | how to install the notebook and its dependencies. |
|
65 | how to install the notebook and its dependencies. | |
66 |
|
66 | |||
67 | .. note:: |
|
67 | .. note:: | |
@@ -358,31 +358,32 b' The files output by ``nbconvert` are currently placed in a new subdirectory call' | |||||
358 |
|
358 | |||
359 | Each of the options for PDF export produces as an intermediate step a root LaTeX ``.tex`` file with the same name as the notebook, as well as individual files for each figure, and ``.text` files with textual output from running code cells; all of these files are located together in the ``nbconvert_build`` subdirectory. |
|
359 | Each of the options for PDF export produces as an intermediate step a root LaTeX ``.tex`` file with the same name as the notebook, as well as individual files for each figure, and ``.text` files with textual output from running code cells; all of these files are located together in the ``nbconvert_build`` subdirectory. | |
360 |
|
360 | |||
361 |
To actually produce the final PDF file, |
|
361 | To actually produce the final PDF file, run the following commands:: | |
362 |
|
362 | |||
|
363 | $ cd nbconvert_build | |||
363 | $ pdflatex notebook |
|
364 | $ pdflatex notebook | |
364 |
|
365 | |||
365 |
This requires a local installation of LaTeX on your machine |
|
366 | This requires a local installation of LaTeX on your machine; | |
366 |
|
|
367 | it outputs the PDF file ``notebook.pdf``, also inside the | |
367 | ``nbconvert_build`` subdirectory. |
|
368 | ``nbconvert_build`` subdirectory. | |
368 |
|
369 | |||
369 | Alternatively, the output may be piped to standard output, ``stdout``, with:: |
|
370 | Alternatively, the output may be piped to standard output, ``stdout``, with:: | |
370 |
|
371 | |||
371 |
|
|
372 | $ ipython nbconvert mynotebook.ipynb --stdout | |
372 |
|
373 | |||
373 | Multiple notebooks can be specified from the command line:: |
|
374 | Multiple notebooks can be specified from the command line:: | |
374 |
|
375 | |||
375 |
|
|
376 | $ ipython nbconvert notebook*.ipynb | |
376 |
|
|
377 | $ ipython nbconvert notebook1.ipynb notebook2.ipynb | |
377 |
|
378 | |||
378 | or via a list in a configuration file, say ``mycfg.py``, containing the text:: |
|
379 | or via a list in a configuration file, say ``mycfg.py``, containing the text:: | |
379 |
|
380 | |||
380 |
|
|
381 | c = get_config() | |
381 |
|
|
382 | c.NbConvertApp.notebooks = ["notebook1.ipynb", "notebook2.ipynb"] | |
382 |
|
383 | |||
383 | and using the command:: |
|
384 | and using the command:: | |
384 |
|
385 | |||
385 |
|
|
386 | $ ipython nbconvert --config mycfg.py | |
386 |
|
387 | |||
387 |
|
388 | |||
388 | Configuring the IPython Notebook |
|
389 | Configuring the IPython Notebook | |
@@ -417,6 +418,7 b' An alternative is to pass an argument to the IPython Notebook, from the moment w' | |||||
417 | ipython notebook --script |
|
418 | ipython notebook --script | |
418 |
|
419 | |||
419 | or you can set this option permanently in your configuration file with:: |
|
420 | or you can set this option permanently in your configuration file with:: | |
|
421 | ||||
420 | c = get_config() |
|
422 | c = get_config() | |
421 | c.NotebookManager.save_script=True |
|
423 | c.NotebookManager.save_script=True | |
422 |
|
424 |
General Comments 0
You need to be logged in to leave comments.
Login now