Show More
@@ -9,33 +9,34 b' The IPython Notebook' | |||||
9 |
|
9 | |||
10 | The IPython Notebook combines two components: |
|
10 | The IPython Notebook combines two components: | |
11 |
|
11 | |||
12 | * A web application, called the *IPython Notebook web app*, for interactive authoring of literate computations, in which explanatory text, mathematics, computations and rich media output may be combined. Input and output are stored in persistent cells that may be edited in-place. |
|
12 | * A web application, called the *IPython Notebook web app*, for interactive | |
|
13 | authoring of literate computations, in which explanatory text, mathematics, | |||
|
14 | computations and rich media output may be combined. Input and output are stored in persistent cells that may be edited in-place. | |||
13 |
|
15 | |||
14 | * Plain text documents, called *notebook documents*, or *notebooks*, for recording and distributing the results of the rich computations. |
|
16 | * Plain text documents, called *notebook documents*, or *notebooks*, for recording and distributing the results of the rich computations. | |
15 |
|
17 | |||
16 | In the documentation, the distinction between the *N*otebook app and *n*otebook documents is made by capitalization. |
|
18 | In the documentation, the distinction between the *N*otebook app and *n*otebook documents is made by capitalization. | |
17 |
|
19 | |||
18 | The Notebook app automatically saves the current state of the computation in the web browser to the corresponding notebook document. |
|
20 | The Notebook app automatically saves, at certain intervals, the current state of the computational process occurring in the web browser to the corresponding notebook document. | |
19 |
|
21 | |||
20 |
|
|
22 | Note that it is also common to refer to the current state of the computation, | |
|
23 | as represented by the sequence of input cells in the Notebook app, as a | |||
21 | *notebook*. There is no problem with confounding these two concepts, since |
|
24 | *notebook*. There is no problem with confounding these two concepts, since | |
22 | there is actually a one-to-one correspondence between what you see on the |
|
25 | there is actually a one-to-one correspondence between what you see on the | |
23 |
|
|
26 | screen inside the app, and what is stored in the corresponding ``.ipynb`` | |
24 |
|
27 | notebook document. | ||
25 |
|
28 | |||
26 |
|
29 | |||
27 | Features of the IPython Notebook web app |
|
30 | Features of the IPython Notebook web app | |
28 | ---------------------------------------- |
|
31 | ---------------------------------------- | |
29 |
|
32 | |||
30 | Some of the main |
|
33 | Some of the main features of the IPython Notebook app include: | |
31 | features of the IPython Notebook app include: |
|
|||
32 |
|
34 | |||
33 | * Display rich data representations (e.g. HTML / LaTeX / SVG) in the browser as a result of computations. |
|
35 | * In-browser editing, syntax highlighting, tab completion and autoindentation for code. | |
34 | * Compose text cells using Markdown and HTML. |
|
36 | * Mix code with rich text using the Markdown markup language. | |
35 | * Include mathematical equations, rendered directly in the browser by MathJax. |
|
37 | * Include mathematical equations using LaTeX notation, rendered directly in the browser by MathJax. | |
36 | * Import standard Python scripts |
|
38 | * Display rich data representations (e.g. HTML / LaTeX / SVG) as the result of computations. | |
37 | * In-browser editing, syntax highlighting, tab completion and autoindentation. |
|
39 | * Include inline figures rendered by the ``matplotlib`` library with publication quality, in a range of formats (SVG / PDF / PNG). | |
38 | * Inline figures rendered by the ``matplotlib`` library with publication quality, in a range of formats (SVG / PDF / PNG). |
|
|||
39 |
|
40 | |||
40 | If you have ever used the Mathematica or SAGE notebooks (the latter is also |
|
41 | If you have ever used the Mathematica or SAGE notebooks (the latter is also | |
41 | web-based__) you should feel right at home. If you have not, you will be |
|
42 | web-based__) you should feel right at home. If you have not, you will be | |
@@ -51,16 +52,14 b' Notebook document files are just standard text files with the extension' | |||||
51 | ``.ipynb``, stored in the working directory on your computer. This file can be easily put under version control and shared with colleagues. |
|
52 | ``.ipynb``, stored in the working directory on your computer. This file can be easily put under version control and shared with colleagues. | |
52 |
|
53 | |||
53 | Despite the fact that the notebook documents are plain text files, they use |
|
54 | Despite the fact that the notebook documents are plain text files, they use | |
54 | the JSON format in order to store a *complete*, *reproducible* copy of the |
|
55 | the JSON format in order to store a *complete*, *reproducible*, *one-to-one* copy of the state of the computational state as it is inside the Notebook app. | |
55 | state of the computation as it is inside the Notebook app. |
|
56 | All computations carried out, and the corresponding results obtained, are combined in a literate way, mixing them with descriptive text, mathematics, and HTML 5 representations of objects. | |
56 | That is, they record all computations carried out and the results obtained in a literate way; inputs and outputs of computations can be freely mixed with descriptive text, mathematics, and HTML 5 objects. |
|
57 | ||
57 |
|
58 | Notebooks may easily be exported to a range of static formats, including | ||
58 |
|
|
59 | HTML (for example, for blog posts), PDF and slide shows. | |
59 | Furthermore, any publicly |
|
60 | Furthermore, any publicly available notebook may be shared via the | |
60 | available notebook may be shared via the `IPython Notebook Viewer |
|
61 | `IPython Notebook Viewer <http://nbviewer.ipython.org>`_ service, which will | |
61 | <http://nbviewer.ipython.org>`_ service, which will provide it as a static web |
|
62 | provide it as a static web page. The results may thus be shared without having to install anything. | |
62 | page. The results may thus be shared without having to install anything. |
|
|||
63 |
|
||||
64 |
|
63 | |||
65 | See :ref:`our installation documentation <install_index>` for directions on |
|
64 | See :ref:`our installation documentation <install_index>` for directions on | |
66 | how to install the notebook and its dependencies. |
|
65 | how to install the notebook and its dependencies. |
General Comments 0
You need to be logged in to leave comments.
Login now