##// END OF EJS Templates
clarify Python 2 kernels install
Matthias Bussonnier -
Show More
@@ -1,96 +1,107 b''
1 .. _kernel_install:
1 .. _kernel_install:
2
2
3 Installing the IPython kernel
3 Installing the IPython kernel
4 =============================
4 =============================
5
5
6 .. seealso::
6 .. seealso::
7
7
8 :ref:`Installing Jupyter <jupyter:install>`
8 :ref:`Installing Jupyter <jupyter:install>`
9 The IPython kernel is the Python execution backend for Jupyter.
9 The IPython kernel is the Python execution backend for Jupyter.
10
10
11 The Jupyter Notebook and other frontends automatically ensure that the IPython kernel is available.
11 The Jupyter Notebook and other frontends automatically ensure that the IPython kernel is available.
12 However, if you want to use a kernel with a different version of Python, or in a virtualenv or conda environment,
12 However, if you want to use a kernel with a different version of Python, or in a virtualenv or conda environment,
13 you'll need to install that manually.
13 you'll need to install that manually.
14
14
15 Kernels for Python 2 and 3
15 Kernels for Python 2 and 3
16 --------------------------
16 --------------------------
17
17
18 If you're running Jupyter on Python 3, you can set up a Python 2 kernel like this::
18 If you're running Jupyter on Python 3, you can set up a Python 2 kernel after
19 checking your version of pip is greater than 9.0::
20
21 python2 -m pip --version
22
23 Then install with ::
19
24
20 python2 -m pip install ipykernel
25 python2 -m pip install ipykernel
21 python2 -m ipykernel install --user
26 python2 -m ipykernel install --user
22
27
23 Or using conda, create a Python 2 environment::
28 Or using conda, create a Python 2 environment::
24
29
25 conda create -n ipykernel_py2 python=2 ipykernel
30 conda create -n ipykernel_py2 python=2 ipykernel
26 source activate ipykernel_py2 # On Windows, remove the word 'source'
31 source activate ipykernel_py2 # On Windows, remove the word 'source'
27 python -m ipykernel install --user
32 python -m ipykernel install --user
28
33
34 .. note::
35
36 The lastest version of IPython has stopped suspport for Python 2, thus
37 installing IPython on Python 2 will give you an older version of IPython
38 (5.x series).
39
29 If you're running Jupyter on Python 2 and want to set up a Python 3 kernel,
40 If you're running Jupyter on Python 2 and want to set up a Python 3 kernel,
30 follow the same steps, replacing ``2`` with ``3``.
41 follow the same steps, replacing ``2`` with ``3``.
31
42
32 The last command installs a :ref:`kernel spec <jupyterclient:kernelspecs>` file
43 The last command installs a :ref:`kernel spec <jupyterclient:kernelspecs>` file
33 for the current python installation. Kernel spec files are JSON files, which
44 for the current python installation. Kernel spec files are JSON files, which
34 can be viewed and changed with a normal text editor.
45 can be viewed and changed with a normal text editor.
35
46
36 .. _multiple_kernel_install:
47 .. _multiple_kernel_install:
37
48
38 Kernels for different environments
49 Kernels for different environments
39 ----------------------------------
50 ----------------------------------
40
51
41 If you want to have multiple IPython kernels for different virtualenvs or conda
52 If you want to have multiple IPython kernels for different virtualenvs or conda
42 environments, you will need to specify unique names for the kernelspecs.
53 environments, you will need to specify unique names for the kernelspecs.
43
54
44 Make sure you have ipykernel installed in your environement. If you are using
55 Make sure you have ipykernel installed in your environement. If you are using
45 ``pip`` to install ``ipykernel`` in a conda env, make sure ``pip`` is
56 ``pip`` to install ``ipykernel`` in a conda env, make sure ``pip`` is
46 installed::
57 installed::
47
58
48 .. sourcecode:: bash
59 .. sourcecode:: bash
49
60
50 source activate myenv
61 source activate myenv
51 conda install pip
62 conda install pip
52 conda install ipykernel # or pip install ipykernel
63 conda install ipykernel # or pip install ipykernel
53
64
54 For example, using conda environments, install a ``Python (myenv)`` Kernel in a first
65 For example, using conda environments, install a ``Python (myenv)`` Kernel in a first
55 environment:
66 environment:
56
67
57 .. sourcecode:: bash
68 .. sourcecode:: bash
58
69
59 source activate myenv
70 source activate myenv
60 python -m ipykernel install --user --name myenv --display-name "Python (myenv)"
71 python -m ipykernel install --user --name myenv --display-name "Python (myenv)"
61
72
62 And in a second environment, after making sure ipykernel is installed in it:
73 And in a second environment, after making sure ipykernel is installed in it:
63
74
64 .. sourcecode:: bash
75 .. sourcecode:: bash
65
76
66 source activate other-env
77 source activate other-env
67 python -m ipykernel install --user --name other-env --display-name "Python (other-env)"
78 python -m ipykernel install --user --name other-env --display-name "Python (other-env)"
68
79
69 The ``--name`` value is used by Jupyter internally. These commands will overwrite
80 The ``--name`` value is used by Jupyter internally. These commands will overwrite
70 any existing kernel with the same name. ``--display-name`` is what you see in
81 any existing kernel with the same name. ``--display-name`` is what you see in
71 the notebook menus.
82 the notebook menus.
72
83
73 Using virtualenv or conda envs, you can make your IPython kernel in one env available to Jupyter in a different env. To do so, run ipykernel install from the kernel's env, with --prefix pointing to the Jupyter env:
84 Using virtualenv or conda envs, you can make your IPython kernel in one env available to Jupyter in a different env. To do so, run ipykernel install from the kernel's env, with --prefix pointing to the Jupyter env:
74
85
75 .. sourcecode:: bash
86 .. sourcecode:: bash
76
87
77 /path/to/kernel/env/bin/python -m ipykernel install --prefix=/path/to/jupyter/env --name 'python-my-env'
88 /path/to/kernel/env/bin/python -m ipykernel install --prefix=/path/to/jupyter/env --name 'python-my-env'
78
89
79 Note that this command will create a new configuration for the kernel in one of the prefered location (see ``jupyter --paths`` command for more details):
90 Note that this command will create a new configuration for the kernel in one of the prefered location (see ``jupyter --paths`` command for more details):
80
91
81 * system-wide (e.g. /usr/local/share),
92 * system-wide (e.g. /usr/local/share),
82 * in Jupyter's env (sys.prefix/share),
93 * in Jupyter's env (sys.prefix/share),
83 * per-user (~/.local/share or ~/Library/share)
94 * per-user (~/.local/share or ~/Library/share)
84
95
85 If you want to edit the kernelspec before installing it, you can do so in two steps.
96 If you want to edit the kernelspec before installing it, you can do so in two steps.
86 First, ask IPython to write its spec to a temporary location:
97 First, ask IPython to write its spec to a temporary location:
87
98
88 .. sourcecode:: bash
99 .. sourcecode:: bash
89
100
90 ipython kernel install --prefix /tmp
101 ipython kernel install --prefix /tmp
91
102
92 edit the files in /tmp/share/jupyter/kernels/python3 to your liking, then when you are ready, tell Jupyter to install it (this will copy the files into a place Jupyter will look):
103 edit the files in /tmp/share/jupyter/kernels/python3 to your liking, then when you are ready, tell Jupyter to install it (this will copy the files into a place Jupyter will look):
93
104
94 .. sourcecode:: bash
105 .. sourcecode:: bash
95
106
96 jupyter kernelspec install /tmp/share/jupyter/kernels/python3
107 jupyter kernelspec install /tmp/share/jupyter/kernels/python3
General Comments 0
You need to be logged in to leave comments. Login now