Skip to content

Commit 30b4a05

Browse files
TravisBotTravisBot
TravisBot
authored and
TravisBot
committed
Updated website (automated commit) – Tuesday, 21. April 2015 07:15PM
1 parent 38c117f commit 30b4a05

File tree

6 files changed

+185
-41
lines changed

6 files changed

+185
-41
lines changed

‎_images/ipy_0.13.png‎

-163 KB
Binary file not shown.

‎_sources/index.txt‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
IPython provides a rich architecture for interactive computing with:
22

33
- Powerful interactive shells (terminal and `Qt-based`_).
4-
- A browser-based notebook_ with support for code, text, mathematical
4+
- A browser-based notebook_ with support for code, rich text, mathematical
55
expressions, inline plots and other rich media.
66
- Support for interactive data visualization and use of `GUI toolkits`_.
77
- Flexible, embeddable_ interpreters to load into your own projects.
@@ -10,6 +10,7 @@ IPython provides a rich architecture for interactive computing with:
1010
.. image:: _static/ipy_0.13.png
1111
:width: 400px
1212
:alt: IPython clients
13+
:text-align: center
1314
:target: _static/ipy_0.13.png
1415

1516
While the focus of the project is Python, our architecture is designed in a

‎_sources/notebook.txt‎

Lines changed: 113 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,135 @@
11
.. _notebook:
22

3+
======================
4+
The IPython Notebook
35
======================
4-
The IPython Notebook
5-
======================
66

7-
The IPython Notebook is a web-based interactive computational environment where
8-
you can combine code execution, text, mathematics, plots and rich media into a
9-
single document:
7+
The IPython Notebook is an interactive computational environment, in which you
8+
can combine code execution, rich text, mathematics, plots and rich media, as
9+
shown in this example session:
10+
11+
.. raw:: html
12+
13+
<div align="center">
1014

1115
.. image:: _static/sloangrant/9_home_fperez_prof_grants_1207-sloan-ipython_proposal_fig_ipython-notebook-specgram.png
12-
:width: 350px
13-
:alt: The IPython notebook with embedded text, code, math and figures.
14-
:target: _static/sloangrant/9_home_fperez_prof_grants_1207-sloan-ipython_proposal_fig_ipython-notebook-specgram.png
16+
:width: 350px
17+
:alt: The IPython notebook with embedded rich text, code, mathematics and figures.
18+
:target: _static/sloangrant/9_home_fperez_prof_grants_1207-sloan-ipython_proposal_fig_ipython-notebook-specgram.png
19+
20+
.. raw:: html
21+
22+
</div>
23+
24+
It aims to be an agile tool for both exploratory computation and data analysis,
25+
and provides a platform to support **reproducible research**, since all inputs
26+
and outputs may be stored in a one-to-one way in notebook documents.
27+
28+
29+
There are two components:
30+
31+
* The **IPython Notebook** web application, 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.
32+
33+
* Plain text documents, called **notebooks**, for recording and distributing the results of the rich computations.
34+
35+
36+
The Notebook app automatically saves the current state of the computation in
37+
the web browser to the corresponding notebook, which is just a standard text
38+
file with the extension ``.ipynb``, stored in a working directory on your
39+
computer. This file can be easily put under version control and shared with
40+
colleagues.
41+
42+
Despite the fact that the notebook documents are plain text files, they use
43+
the JSON format in order to store a **complete**, **reproducible** copy of the
44+
current state of the computation inside the Notebook app.
45+
46+
Features of the IPython Notebook web app
47+
----------------------------------------
48+
49+
Some of the main features of the IPython Notebook app include:
1550

51+
* Display rich data representations (e.g. HTML / LaTeX / SVG) in the browser as a result of computations.
52+
* Compose rich text using Markdown_ and HTML.
53+
* Include mathematical equations, rendered directly in the browser by MathJax_.
54+
* Import standard Python scripts.
55+
* In-browser editing, syntax highlighting, tab completion and autoindentation.
56+
* Inline figures rendered by the matplotlib_ library with publication quality, in a range of formats (SVG / PDF / PNG).
57+
58+
.. _matplotlib: http://matplotlib.org
59+
.. _Markdown: http://daringfireball.net/projects/markdown/syntax
60+
.. _MathJax: http://mathjax.org
61+
62+
If you have ever used the Mathematica or SAGE notebooks (the latter is also
63+
web-based__) you should feel right at home. If you have not, you will be
64+
able to learn how to use the IPython Notebook in just a few minutes.
65+
66+
.. __: http://sagenb.org
67+
68+
69+
Notebook documents
70+
------------------
71+
72+
Notebook documents (or notebooks) are files which record all computations
73+
carried out and the results obtained in a literate way, including inputs,
74+
outputs, toegether with descriptive text and mathematics.
75+
76+
They are plain text files, which are thus easy to share with colleagues and
77+
place under version control. But, by using the JSON format, they can record
78+
all aspects of the computation, including embedding rich media output. The
79+
standard file extension for notebook documents is ``.ipynb``.
80+
81+
Notebooks may easily be exported_ to a range of static formats, including HTML
82+
(for example, for blog posts), PDF and slide shows. Any publicly
83+
available notebook may be shared via the `IPython Notebook Viewer
84+
<http://nbviewer.ipython.org>`_ service, which will provide it as a static web
85+
page. This makes it easy to give your colleagues a document they
86+
can read immediately without having to install anything.
1687

17-
These notebooks are normal files that can be shared with colleagues, converted
18-
to other formats such as HTML or PDF, etc. You can share any publicly
19-
available notebook by using the `IPython Notebook Viewer
20-
<http://nbviewer.ipython.org>`_ service which will render it as a static web
21-
page. This makes it easy to give your colleagues a document they can read
22-
immediately without having to install anything.
2388

2489
To learn more about using the IPython Notebook, you can visit our `example
25-
collection`_, and you can read the documentation_ for all the details on how to
26-
use and configure the system. The `Notebook Gallery`_ showcases many
90+
collection`_, and you can read the documentation_ for all the details on how
91+
to use and configure the system. The `notebook gallery`_ showcases many
2792
interesting notebooks covering a variety of topics, from basic programming to
2893
advanced scientific computing.
2994

30-
31-
Here is a short demo of the notebook's basic features by the Pybonacci_ team:
95+
Here is a short demo of the IPython Notebook's basic features by the
96+
Pybonacci_ team:
3297

3398
.. raw:: html
3499

35-
<div align="center"> <iframe title="YouTube video player2" width="550"
36-
height="350" src="http://www.youtube.com/embed/H6dLGQw9yFQ" frameborder="0"
37-
allowfullscreen></iframe></div><br>
100+
<div align="center">
101+
<iframe title="YouTube video player2"
102+
width="550" height="350"
103+
src="http://www.youtube.com/embed/H6dLGQw9yFQ"
104+
frameborder="0" allowfullscreen>
105+
</iframe></div><br>
38106

39107
.. _Pybonacci: http://pybonacci.org
40108

41109
.. _example collection: http://nbviewer.ipython.org/github/ipython/ipython/blob/2.x/examples/Notebook/Index.ipynb
42110

43-
.. _documentation: http://ipython.org/ipython-doc/stable/interactive/htmlnotebook.html
111+
.. _documentation: http://ipython.org/ipython-doc/stable/interactive/notebook.html
112+
113+
.. _exported: http://ipython.org/ipython-doc/stable/interactive/nbconvert.html
114+
115+
.. _notebook gallery:
116+
https://github.com/ipython/ipython/wiki/A-gallery-of-interesting-IPython-Notebooks
117+
118+
For a thorough introduction to the IPython Notebook, you can check out the
119+
*IPython in Depth* tutorial from the `SciPy 2013`_ scientific Python
120+
conference, led by the two creators of the IPython package, Fernando Pérez
121+
and Brian Granger:
122+
123+
.. raw:: html
124+
125+
<div align="center">
126+
<iframe title="YouTube video player3"
127+
<iframe width="560" height="315"
128+
src="http://www.youtube.com/embed/xe_ATRmw0KM" frameborder="0"
129+
allowfullscreen></iframe>
130+
</div><br>
131+
132+
133+
.. _SciPy 2013:
134+
.. https://conference.scipy.org/scipy2013/
44135

45-
.. _notebook gallery: https://github.com/ipython/ipython/wiki/A-gallery-of-interesting-IPython-Notebooks

‎index.html‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -232,13 +232,12 @@ <h4>Support IPython</h4>
232232
<p>IPython provides a rich architecture for interactive computing with:</p>
233233
<ul class="simple">
234234
<li>Powerful interactive shells (terminal and <a class="reference external" href="http://ipython.org/ipython-doc/stable/interactive/qtconsole.html">Qt-based</a>).</li>
235-
<li>A browser-based <a class="reference external" href="notebook.html">notebook</a> with support for code, text, mathematical
235+
<li>A browser-based <a class="reference external" href="notebook.html">notebook</a> with support for code, rich text, mathematical
236236
expressions, inline plots and other rich media.</li>
237237
<li>Support for interactive data visualization and use of <a class="reference external" href="http://ipython.org/ipython-doc/stable/interactive/reference.html#gui-event-loop-support">GUI toolkits</a>.</li>
238238
<li>Flexible, <a class="reference external" href="http://ipython.org/ipython-doc/stable/interactive/reference.html#embedding-ipython">embeddable</a> interpreters to load into your own projects.</li>
239239
<li>Easy to use, high performance tools for <a class="reference external" href="http://ipython.org/ipython-doc/stable/parallel/parallel_intro.html">parallel computing</a>.</li>
240240
</ul>
241-
<a class="reference external image-reference" href="_static/ipy_0.13.png"><img alt="IPython clients" src="_images/ipy_0.13.png" style="width: 400px;" /></a>
242241
<p>While the focus of the project is Python, our architecture is designed in a
243242
language-agnostic way to facilitate interactive computing in any language. An
244243
interactive kernel speaks to clients such as the terminal or web notebook via a

‎notebook.html‎

Lines changed: 69 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -232,24 +232,78 @@ <h4>Support IPython</h4>
232232

233233
<div class="section" id="the-ipython-notebook">
234234
<span id="notebook"></span><h1>The IPython Notebook<a class="headerlink" href="#the-ipython-notebook" title="Permalink to this headline"></a></h1>
235-
<p>The IPython Notebook is a web-based interactive computational environment where
236-
you can combine code execution, text, mathematics, plots and rich media into a
237-
single document:</p>
238-
<a class="reference external image-reference" href="_static/sloangrant/9_home_fperez_prof_grants_1207-sloan-ipython_proposal_fig_ipython-notebook-specgram.png"><img alt="The IPython notebook with embedded text, code, math and figures." src="_images/9_home_fperez_prof_grants_1207-sloan-ipython_proposal_fig_ipython-notebook-specgram.png" style="width: 350px;" /></a>
239-
<p>These notebooks are normal files that can be shared with colleagues, converted
240-
to other formats such as HTML or PDF, etc. You can share any publicly
241-
available notebook by using the <a class="reference external" href="http://nbviewer.ipython.org">IPython Notebook Viewer</a> service which will render it as a static web
242-
page. This makes it easy to give your colleagues a document they can read
243-
immediately without having to install anything.</p>
235+
<p>The IPython Notebook is an interactive computational environment, in which you
236+
can combine code execution, rich text, mathematics, plots and rich media, as
237+
shown in this example session:</p>
238+
<div align="center"><a class="reference external image-reference" href="_static/sloangrant/9_home_fperez_prof_grants_1207-sloan-ipython_proposal_fig_ipython-notebook-specgram.png"><img alt="The IPython notebook with embedded rich text, code, mathematics and figures." src="_images/9_home_fperez_prof_grants_1207-sloan-ipython_proposal_fig_ipython-notebook-specgram.png" style="width: 350px;" /></a>
239+
</div><p>It aims to be an agile tool for both exploratory computation and data analysis,
240+
and provides a platform to support <strong>reproducible research</strong>, since all inputs
241+
and outputs may be stored in a one-to-one way in notebook documents.</p>
242+
<p>There are two components:</p>
243+
<ul class="simple">
244+
<li>The <strong>IPython Notebook</strong> web application, 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.</li>
245+
<li>Plain text documents, called <strong>notebooks</strong>, for recording and distributing the results of the rich computations.</li>
246+
</ul>
247+
<p>The Notebook app automatically saves the current state of the computation in
248+
the web browser to the corresponding notebook, which is just a standard text
249+
file with the extension <code class="docutils literal"><span class="pre">.ipynb</span></code>, stored in a working directory on your
250+
computer. This file can be easily put under version control and shared with
251+
colleagues.</p>
252+
<p>Despite the fact that the notebook documents are plain text files, they use
253+
the JSON format in order to store a <strong>complete</strong>, <strong>reproducible</strong> copy of the
254+
current state of the computation inside the Notebook app.</p>
255+
<div class="section" id="features-of-the-ipython-notebook-web-app">
256+
<h2>Features of the IPython Notebook web app<a class="headerlink" href="#features-of-the-ipython-notebook-web-app" title="Permalink to this headline"></a></h2>
257+
<p>Some of the main features of the IPython Notebook app include:</p>
258+
<ul class="simple">
259+
<li>Display rich data representations (e.g. HTML / LaTeX / SVG) in the browser as a result of computations.</li>
260+
<li>Compose rich text using <a class="reference external" href="http://daringfireball.net/projects/markdown/syntax">Markdown</a> and HTML.</li>
261+
<li>Include mathematical equations, rendered directly in the browser by <a class="reference external" href="http://mathjax.org">MathJax</a>.</li>
262+
<li>Import standard Python scripts.</li>
263+
<li>In-browser editing, syntax highlighting, tab completion and autoindentation.</li>
264+
<li>Inline figures rendered by the <a class="reference external" href="http://matplotlib.org">matplotlib</a> library with publication quality, in a range of formats (SVG / PDF / PNG).</li>
265+
</ul>
266+
<p>If you have ever used the Mathematica or SAGE notebooks (the latter is also
267+
<a class="reference external" href="http://sagenb.org">web-based</a>) you should feel right at home. If you have not, you will be
268+
able to learn how to use the IPython Notebook in just a few minutes.</p>
269+
</div>
270+
<div class="section" id="notebook-documents">
271+
<h2>Notebook documents<a class="headerlink" href="#notebook-documents" title="Permalink to this headline"></a></h2>
272+
<p>Notebook documents (or notebooks) are files which record all computations
273+
carried out and the results obtained in a literate way, including inputs,
274+
outputs, toegether with descriptive text and mathematics.</p>
275+
<p>They are plain text files, which are thus easy to share with colleagues and
276+
place under version control. But, by using the JSON format, they can record
277+
all aspects of the computation, including embedding rich media output. The
278+
standard file extension for notebook documents is <code class="docutils literal"><span class="pre">.ipynb</span></code>.</p>
279+
<p>Notebooks may easily be <a class="reference external" href="http://ipython.org/ipython-doc/stable/interactive/nbconvert.html">exported</a> to a range of static formats, including HTML
280+
(for example, for blog posts), PDF and slide shows. Any publicly
281+
available notebook may be shared via the <a class="reference external" href="http://nbviewer.ipython.org">IPython Notebook Viewer</a> service, which will provide it as a static web
282+
page. This makes it easy to give your colleagues a document they
283+
can read immediately without having to install anything.</p>
244284
<p>To learn more about using the IPython Notebook, you can visit our <a class="reference external" href="http://nbviewer.ipython.org/github/ipython/ipython/blob/2.x/examples/Notebook/Index.ipynb">example
245-
collection</a>, and you can read the <a class="reference external" href="http://ipython.org/ipython-doc/stable/interactive/htmlnotebook.html">documentation</a> for all the details on how to
246-
use and configure the system. The <a class="reference external" href="https://github.com/ipython/ipython/wiki/A-gallery-of-interesting-IPython-Notebooks">Notebook Gallery</a> showcases many
285+
collection</a>, and you can read the <a class="reference external" href="http://ipython.org/ipython-doc/stable/interactive/notebook.html">documentation</a> for all the details on how
286+
to use and configure the system. The <a class="reference external" href="https://github.com/ipython/ipython/wiki/A-gallery-of-interesting-IPython-Notebooks">notebook gallery</a> showcases many
247287
interesting notebooks covering a variety of topics, from basic programming to
248288
advanced scientific computing.</p>
249-
<p>Here is a short demo of the notebook&#8217;s basic features by the <a class="reference external" href="http://pybonacci.org">Pybonacci</a> team:</p>
250-
<div align="center"> <iframe title="YouTube video player2" width="550"
251-
height="350" src="http://www.youtube.com/embed/H6dLGQw9yFQ" frameborder="0"
252-
allowfullscreen></iframe></div><br></div>
289+
<p>Here is a short demo of the IPython Notebook&#8217;s basic features by the
290+
<a class="reference external" href="http://pybonacci.org">Pybonacci</a> team:</p>
291+
<div align="center">
292+
<iframe title="YouTube video player2"
293+
width="550" height="350"
294+
src="http://www.youtube.com/embed/H6dLGQw9yFQ"
295+
frameborder="0" allowfullscreen>
296+
</iframe></div><br><p>For a thorough introduction to the IPython Notebook, you can check out the
297+
<em>IPython in Depth</em> tutorial from the <a class="reference internal" href="#scipy-2013">SciPy 2013</a> scientific Python
298+
conference, led by the two creators of the IPython package, Fernando Pérez
299+
and Brian Granger:</p>
300+
<div align="center">
301+
<iframe title="YouTube video player3"
302+
<iframe width="560" height="315"
303+
src="http://www.youtube.com/embed/xe_ATRmw0KM" frameborder="0"
304+
allowfullscreen></iframe>
305+
</div><br><span class="target" id="scipy-2013"></span></div>
306+
</div>
253307

254308

255309
</div>

‎objects.inv‎

14 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)