##// END OF EJS Templates
upstream » ipython
RSS

Clone from https://github.com/ipython/ipython.git

Merge pull request #9103 from takluyver/kernel-install-doc...
Min RK -
r21881:1e654998 merge
parent child Browse files
Show More
Show file before | Show file after | Hide comments
@@ -1,62 +1,39 b''
1 .. _kernel_install:
1 .. _kernel_install:
2
2
3 Installing the IPython kernel
3 Installing the IPython kernel
4 =============================
4 =============================
5
5
6 IPython can be installed (different python versions, virtualenv or conda
6 The Jupyter Notebook and other frontends automatically ensure that the IPython kernel is available.
7 environments) as a kernel for Jupyter by following these steps:
7 However, if you want to use a kernel with a different version of Python, or in a virtualenv or conda environment,
8
8 you'll need to install that manually.
9 * make sure that the desired python installation is active
10 (e.g. activate the environment, or use absolute paths)
11 and ipykernel is installed
12 * run once ``ipython kernel install --user``,
13 or ``python -m ipykernel install --user`` to ensure a specific Python installation is used.
14 * See `ipython kernel install --help` for the list of installation options like
15 naming the kernel, or non default install location.
16 * The IPython kernel for Jupyter is provided by the `ipykernel` python package,
17 see `ipykernel documentation <http://ipykernel.readthedocs.org/>`_ if you
18 need more flexibility for installation.
19
20
21 For example:
22
23 .. sourcecode:: bash
24
25 source activate kernel-environment
26 ipython kernel install --user
27 source deactivate kernel-environment
28
9
29 or
10 Using the Python version or environment for which you want to set up the kernel, run::
30
11
31 .. sourcecode:: bash
12 pip install ipykernel # or: conda install ipykernel
32
13 python -m ipykernel install --user
33 ~/envs/kernel-environment/python -m ipykernel install --user
34
14
35 The last command installs a :ref:`kernel spec <jupyterclient:kernelspecs>` file
15 The last command installs a :ref:`kernel spec <jupyterclient:kernelspecs>` file
36 for the current python installation. Kernel spec files are JSON files, which
16 for the current python installation. Kernel spec files are JSON files, which
37 can be viewed and changed with a normal text editor.
17 can be viewed and changed with a normal text editor.
38
18
39
19 See `python -m ipykernel install --help` for the list of installation options like
40 .. note ::
20 naming the kernel, or non default install location.
41
42 The command `ipython kernelspec` is deprecated and will be removed in future versions.
43
44
21
45 .. _multiple_kernel_install:
22 .. _multiple_kernel_install:
46
23
47 Multiple IPython installs
24 Multiple IPython installations
48 =========================
25 ==============================
49
26
50 If you want to have multiple IPython kernels for different environments,
27 If you want to have multiple IPython kernels for different environments,
51 you will need to specify unique names for the kernelspecs,
28 you will need to specify unique names for the kernelspecs,
52 and you may also want to specify the display name of those kernels,
29 and you may also want to specify the display name of those kernels,
53 so that you can clearly see which is which in the notebook menus:
30 so that you can clearly see which is which in the notebook menus:
54
31
55 .. sourcecode:: bash
32 .. sourcecode:: bash
56
33
57 source activate myenv
34 source activate myenv
58 ipython kernel install --user --name myenv --display-name "Python (myenv)"
35 ipython kernel install --user --name myenv --display-name "Python (myenv)"
59 source activate other-env
36 source activate other-env
60 ipython kernel install --user --name other-env --display-name "Python (other-env)"
37 ipython kernel install --user --name other-env --display-name "Python (other-env)"
61 source deactivate
38 source deactivate
62
39
General Comments 0
You need to be logged in to leave comments. Login now