##// END OF EJS Templates
Merge pull request #9103 from takluyver/kernel-install-doc...
Min RK -
r21881:1e654998 merge
parent child Browse files
Show More
@@ -3,49 +3,26 b''
3 3 Installing the IPython kernel
4 4 =============================
5 5
6 IPython can be installed (different python versions, virtualenv or conda
7 environments) as a kernel for Jupyter by following these steps:
6 The Jupyter Notebook and other frontends automatically ensure that the IPython kernel is available.
7 However, if you want to use a kernel with a different version of Python, or in a virtualenv or conda environment,
8 you'll need to install that manually.
8 9
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.
10 Using the Python version or environment for which you want to set up the kernel, run::
19 11
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
29 or
30
31 .. sourcecode:: bash
32
33 ~/envs/kernel-environment/python -m ipykernel install --user
12 pip install ipykernel # or: conda install ipykernel
13 python -m ipykernel install --user
34 14
35 15 The last command installs a :ref:`kernel spec <jupyterclient:kernelspecs>` file
36 16 for the current python installation. Kernel spec files are JSON files, which
37 17 can be viewed and changed with a normal text editor.
38 18
39
40 .. note ::
41
42 The command `ipython kernelspec` is deprecated and will be removed in future versions.
43
19 See `python -m ipykernel install --help` for the list of installation options like
20 naming the kernel, or non default install location.
44 21
45 22 .. _multiple_kernel_install:
46 23
47 Multiple IPython installs
48 =========================
24 Multiple IPython installations
25 ==============================
49 26
50 27 If you want to have multiple IPython kernels for different environments,
51 28 you will need to specify unique names for the kernelspecs,
General Comments 0
You need to be logged in to leave comments. Login now