Show More
@@ -1,106 +1,106 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 after |
|
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:: |
|
19 | checking your version of pip is greater than 9.0:: | |
20 |
|
20 | |||
21 | python2 -m pip --version |
|
21 | python2 -m pip --version | |
22 |
|
22 | |||
23 | Then install with :: |
|
23 | Then install with :: | |
24 |
|
24 | |||
25 | python2 -m pip install ipykernel |
|
25 | python2 -m pip install ipykernel | |
26 | python2 -m ipykernel install --user |
|
26 | python2 -m ipykernel install --user | |
27 |
|
27 | |||
28 | Or using conda, create a Python 2 environment:: |
|
28 | Or using conda, create a Python 2 environment:: | |
29 |
|
29 | |||
30 | conda create -n ipykernel_py2 python=2 ipykernel |
|
30 | conda create -n ipykernel_py2 python=2 ipykernel | |
31 | source activate ipykernel_py2 # On Windows, remove the word 'source' |
|
31 | source activate ipykernel_py2 # On Windows, remove the word 'source' | |
32 | python -m ipykernel install --user |
|
32 | python -m ipykernel install --user | |
33 |
|
33 | |||
34 | .. note:: |
|
34 | .. note:: | |
35 |
|
35 | |||
36 | IPython 6.0 stopped support for Python 2, so |
|
36 | IPython 6.0 stopped support for Python 2, so | |
37 | installing IPython on Python 2 will give you an older version (5.x series). |
|
37 | installing IPython on Python 2 will give you an older version (5.x series). | |
38 |
|
38 | |||
39 | If you're running Jupyter on Python 2 and want to set up a Python 3 kernel, |
|
39 | If you're running Jupyter on Python 2 and want to set up a Python 3 kernel, | |
40 | follow the same steps, replacing ``2`` with ``3``. |
|
40 | follow the same steps, replacing ``2`` with ``3``. | |
41 |
|
41 | |||
42 | The last command installs a :ref:`kernel spec <jupyterclient:kernelspecs>` file |
|
42 | The last command installs a :ref:`kernel spec <jupyterclient:kernelspecs>` file | |
43 | for the current python installation. Kernel spec files are JSON files, which |
|
43 | for the current python installation. Kernel spec files are JSON files, which | |
44 | can be viewed and changed with a normal text editor. |
|
44 | can be viewed and changed with a normal text editor. | |
45 |
|
45 | |||
46 | .. _multiple_kernel_install: |
|
46 | .. _multiple_kernel_install: | |
47 |
|
47 | |||
48 | Kernels for different environments |
|
48 | Kernels for different environments | |
49 | ---------------------------------- |
|
49 | ---------------------------------- | |
50 |
|
50 | |||
51 | If you want to have multiple IPython kernels for different virtualenvs or conda |
|
51 | If you want to have multiple IPython kernels for different virtualenvs or conda | |
52 | environments, you will need to specify unique names for the kernelspecs. |
|
52 | environments, you will need to specify unique names for the kernelspecs. | |
53 |
|
53 | |||
54 | Make sure you have ipykernel installed in your environement. If you are using |
|
54 | Make sure you have ipykernel installed in your environement. If you are using | |
55 | ``pip`` to install ``ipykernel`` in a conda env, make sure ``pip`` is |
|
55 | ``pip`` to install ``ipykernel`` in a conda env, make sure ``pip`` is | |
56 |
installed: |
|
56 | installed: | |
57 |
|
57 | |||
58 | .. sourcecode:: bash |
|
58 | .. sourcecode:: bash | |
59 |
|
59 | |||
60 | source activate myenv |
|
60 | source activate myenv | |
61 | conda install pip |
|
61 | conda install pip | |
62 | conda install ipykernel # or pip install ipykernel |
|
62 | conda install ipykernel # or pip install ipykernel | |
63 |
|
63 | |||
64 | For example, using conda environments, install a ``Python (myenv)`` Kernel in a first |
|
64 | For example, using conda environments, install a ``Python (myenv)`` Kernel in a first | |
65 | environment: |
|
65 | environment: | |
66 |
|
66 | |||
67 | .. sourcecode:: bash |
|
67 | .. sourcecode:: bash | |
68 |
|
68 | |||
69 | source activate myenv |
|
69 | source activate myenv | |
70 | python -m ipykernel install --user --name myenv --display-name "Python (myenv)" |
|
70 | python -m ipykernel install --user --name myenv --display-name "Python (myenv)" | |
71 |
|
71 | |||
72 | And in a second environment, after making sure ipykernel is installed in it: |
|
72 | And in a second environment, after making sure ipykernel is installed in it: | |
73 |
|
73 | |||
74 | .. sourcecode:: bash |
|
74 | .. sourcecode:: bash | |
75 |
|
75 | |||
76 | source activate other-env |
|
76 | source activate other-env | |
77 | python -m ipykernel install --user --name other-env --display-name "Python (other-env)" |
|
77 | python -m ipykernel install --user --name other-env --display-name "Python (other-env)" | |
78 |
|
78 | |||
79 | The ``--name`` value is used by Jupyter internally. These commands will overwrite |
|
79 | The ``--name`` value is used by Jupyter internally. These commands will overwrite | |
80 | any existing kernel with the same name. ``--display-name`` is what you see in |
|
80 | any existing kernel with the same name. ``--display-name`` is what you see in | |
81 | the notebook menus. |
|
81 | the notebook menus. | |
82 |
|
82 | |||
83 | 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: |
|
83 | 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 |
|
84 | |||
85 | .. sourcecode:: bash |
|
85 | .. sourcecode:: bash | |
86 |
|
86 | |||
87 | /path/to/kernel/env/bin/python -m ipykernel install --prefix=/path/to/jupyter/env --name 'python-my-env' |
|
87 | /path/to/kernel/env/bin/python -m ipykernel install --prefix=/path/to/jupyter/env --name 'python-my-env' | |
88 |
|
88 | |||
89 | 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): |
|
89 | 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 |
|
90 | |||
91 | * system-wide (e.g. /usr/local/share), |
|
91 | * system-wide (e.g. /usr/local/share), | |
92 | * in Jupyter's env (sys.prefix/share), |
|
92 | * in Jupyter's env (sys.prefix/share), | |
93 | * per-user (~/.local/share or ~/Library/share) |
|
93 | * per-user (~/.local/share or ~/Library/share) | |
94 |
|
94 | |||
95 | If you want to edit the kernelspec before installing it, you can do so in two steps. |
|
95 | If you want to edit the kernelspec before installing it, you can do so in two steps. | |
96 | First, ask IPython to write its spec to a temporary location: |
|
96 | First, ask IPython to write its spec to a temporary location: | |
97 |
|
97 | |||
98 | .. sourcecode:: bash |
|
98 | .. sourcecode:: bash | |
99 |
|
99 | |||
100 | ipython kernel install --prefix /tmp |
|
100 | ipython kernel install --prefix /tmp | |
101 |
|
101 | |||
102 | 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): |
|
102 | 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 |
|
103 | |||
104 | .. sourcecode:: bash |
|
104 | .. sourcecode:: bash | |
105 |
|
105 | |||
106 | jupyter kernelspec install /tmp/share/jupyter/kernels/python3 |
|
106 | jupyter kernelspec install /tmp/share/jupyter/kernels/python3 |
General Comments 0
You need to be logged in to leave comments.
Login now