Show More
@@ -3,10 +3,18 b'' | |||||
3 | The IPython Notebook |
|
3 | The IPython Notebook | |
4 | ==================== |
|
4 | ==================== | |
5 |
|
5 | |||
|
6 | The IPython Notebook is part of the IPython package, which aims to provide a powerful, interactive approach to scientific computation. | |||
|
7 | The IPython Notebook extends the previous text-console-based approach, and the later Qt console, in a qualitatively new diretion, providing a web-based application suitable for capturing the whole scientific computation process. | |||
|
8 | ||||
|
9 | ||||
6 | .. seealso:: |
|
10 | .. seealso:: | |
7 |
|
11 | |||
8 | :ref:`Installation requirements <installnotebook>` for the Notebook. |
|
12 | :ref:`Installation requirements <installnotebook>` for the Notebook. | |
9 |
|
13 | |||
|
14 | ||||
|
15 | Introduction | |||
|
16 | ------------ | |||
|
17 | ||||
10 | The IPython Notebook combines two components: |
|
18 | The IPython Notebook combines two components: | |
11 |
|
19 | |||
12 | * **The *IPython Notebook* web application**: |
|
20 | * **The *IPython Notebook* web application**: | |
@@ -17,24 +25,24 b' The IPython Notebook combines two components:' | |||||
17 |
|
25 | |||
18 | *Notebook documents*, or *notebooks*, are plain text documents which record all inputs and outputs of the computations, interspersed with text, mathematics and HTML 5 representations of objects, in a literate style. |
|
26 | *Notebook documents*, or *notebooks*, are plain text documents which record all inputs and outputs of the computations, interspersed with text, mathematics and HTML 5 representations of objects, in a literate style. | |
19 |
|
27 | |||
20 |
Since the similarity in names can lead to some confusion, in the documentation |
|
28 | Since the similarity in names can lead to some confusion, in the documentation we will always use the typographical distinction between the *N*otebook app and *n*otebook documents via the respective capitalization of the word "notebook". Here, we are 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, to increase clarity. | |
21 |
|
29 | |||
22 | 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 | |
23 |
*notebook space*. Notebook documents provide an *exact*, *one-to-one* record of all the content in the notebook space, a |
|
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 name "notebook" for both the notebook space and the corresonding notebook document. | |
24 |
|
32 | |||
25 | Features of the IPython Notebook web app |
|
33 | Features of the IPython Notebook web app | |
26 | ---------------------------------------- |
|
34 | ---------------------------------------- | |
27 |
|
35 | |||
28 | Some of the main features of the IPython Notebook app include: |
|
36 | Some of the main features of the IPython Notebook app include: | |
29 |
|
37 | |||
30 |
* In-browser editing, syntax highlighting, tab completion and autoindentation |
|
38 | * In-browser editing for code, with automatic syntax highlighting, tab completion and autoindentation. | |
31 |
* |
|
39 | * Literate combination of code with rich text using the Markdown markup language. | |
32 |
* |
|
40 | * Mathematics is easily included within the Markdown using LaTeX notation, and rendered natively by MathJax. | |
33 | * Display rich data representations (e.g. HTML / LaTeX / SVG) as the result of computations. |
|
41 | * Displays rich data representations (e.g. HTML / LaTeX / SVG) as the result of computations. | |
34 | * Include inline figures rendered by the ``matplotlib`` library with publication quality, in a range of formats (SVG / PDF / PNG). |
|
42 | * Publication-quality figures in a range of formats (SVG / PDF / PNG), rendered by the ``matplotlib`` library, may be included inline. | |
35 |
|
43 | |||
36 | If you have ever used the Mathematica or SAGE notebooks (the latter is also |
|
44 | If you have ever used the Mathematica or SAGE notebooks (the latter is also | |
37 |
web-based__) you should feel right at home. I |
|
45 | web-based__) you should feel right at home. In any case, you will be | |
38 | able to learn how to use the IPython Notebook in just a few minutes. |
|
46 | able to learn how to use the IPython Notebook in just a few minutes. | |
39 |
|
47 | |||
40 | .. __: http://sagenb.org |
|
48 | .. __: http://sagenb.org | |
@@ -43,7 +51,7 b' able to learn how to use the IPython Notebook in just a few minutes.' | |||||
43 | Notebook documents |
|
51 | Notebook documents | |
44 | ------------------ |
|
52 | ------------------ | |
45 |
|
53 | |||
46 |
Notebook document files are just |
|
54 | Notebook document files are just standard text files with the extension | |
47 | ``.ipynb``, stored in the working directory on your computer. This file can be easily put under version control and shared with colleagues. |
|
55 | ``.ipynb``, stored in the working directory on your computer. This file can be easily put under version control and shared with colleagues. | |
48 |
|
56 | |||
49 | Despite the fact that the notebook documents are plain text files, they use |
|
57 | Despite the fact that the notebook documents are plain text files, they use |
General Comments 0
You need to be logged in to leave comments.
Login now