Show More
@@ -1,49 +1,49 b'' | |||||
1 | =========================================== |
|
1 | =========================================== | |
2 | IPython: Productive Interactive Computing |
|
2 | IPython: Productive Interactive Computing | |
3 | =========================================== |
|
3 | =========================================== | |
4 |
|
4 | |||
5 | Overview |
|
5 | Overview | |
6 | ======== |
|
6 | ======== | |
7 |
|
7 | |||
8 | Welcome to IPython. Our full documentation is available on `our website |
|
8 | Welcome to IPython. Our full documentation is available on `our website | |
9 | <http://ipython.org/documentation.html>`_; if you downloaded a built source |
|
9 | <http://ipython.org/documentation.html>`_; if you downloaded a built source | |
10 | distribution the ``docs/source`` directory contains the plaintext version of |
|
10 | distribution the ``docs/source`` directory contains the plaintext version of | |
11 | these manuals. If you have Sphinx installed, you can build them by typing |
|
11 | these manuals. If you have Sphinx installed, you can build them by typing | |
12 | ``cd docs; make html`` for local browsing. |
|
12 | ``cd docs; make html`` for local browsing. | |
13 |
|
13 | |||
14 |
|
14 | |||
15 | Dependencies and supported Python versions |
|
15 | Dependencies and supported Python versions | |
16 | ========================================== |
|
16 | ========================================== | |
17 |
|
17 | |||
18 | For full details, see the installation section of the manual. The basic parts |
|
18 | For full details, see the installation section of the manual. The basic parts | |
19 | of IPython only need the Python standard library, but much of its more advanced |
|
19 | of IPython only need the Python standard library, but much of its more advanced | |
20 | functionality requires extra packages. |
|
20 | functionality requires extra packages. | |
21 |
|
21 | |||
22 | Officially, IPython requires Python version 2.6, 2.7, or 3.1 and above. |
|
22 | Officially, IPython requires Python version 2.6, 2.7, or 3.1 and above. | |
23 |
|
23 | |||
24 |
|
24 | |||
25 | Instant running |
|
25 | Instant running | |
26 | =============== |
|
26 | =============== | |
27 |
|
27 | |||
28 | You can run IPython from this directory without even installing it system-wide |
|
28 | You can run IPython from this directory without even installing it system-wide | |
29 | by typing at the terminal:: |
|
29 | by typing at the terminal:: | |
30 |
|
30 | |||
31 |
$ python |
|
31 | $ python -m IPython | |
32 |
|
32 | |||
33 |
|
33 | |||
34 | Development installation |
|
34 | Development installation | |
35 | ======================== |
|
35 | ======================== | |
36 |
|
36 | |||
37 | If you want to hack on certain parts, e.g. the IPython notebook, in a clean |
|
37 | If you want to hack on certain parts, e.g. the IPython notebook, in a clean | |
38 | environment (such as a virtualenv) you can use ``pip`` to grab the necessary |
|
38 | environment (such as a virtualenv) you can use ``pip`` to grab the necessary | |
39 | dependencies quickly:: |
|
39 | dependencies quickly:: | |
40 |
|
40 | |||
41 | $ pip install -e .[notebook] |
|
41 | $ pip install -e .[notebook] | |
42 |
|
42 | |||
43 | This installs the necessary packages and symlinks IPython into your current |
|
43 | This installs the necessary packages and symlinks IPython into your current | |
44 | environment so that you can work on your local repo copy and run it from anywhere:: |
|
44 | environment so that you can work on your local repo copy and run it from anywhere:: | |
45 |
|
45 | |||
46 | $ ipython notebook |
|
46 | $ ipython notebook | |
47 |
|
47 | |||
48 | The same process applies for other parts, such as the qtconsole (the |
|
48 | The same process applies for other parts, such as the qtconsole (the | |
49 | ``extras_require`` attribute in the setup.py file lists all the possibilities). |
|
49 | ``extras_require`` attribute in the setup.py file lists all the possibilities). |
General Comments 0
You need to be logged in to leave comments.
Login now