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