##// END OF EJS Templates
Add additional information to installing ipython docs
Piotr Przetacznik -
Show More
@@ -54,32 +54,22 b' The ``--name`` value is used by Jupyter internally. These commands will overwrit'
54 54 any existing kernel with the same name. ``--display-name`` is what you see in
55 55 the notebook menus.
56 56
57 Using virtualenv you can add your new environments by linking to specific instance of your Python:
57 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:
58 58
59 59 .. sourcecode:: bash
60 60
61 python -m ipykernel install --prefix=/path/to/new_env --name python_new_env
62
61 /path/to/kernel/env/bin/python -m ipykernel install --prefix=/path/to/jupyter/env --name 'python-my-env'
62
63 63 Note that this command will create new configuration for kernel in one of it's prefered location (see ``jupyter --paths`` command for more details):
64 64
65 65 * system-wide (e.g. /usr/local/share),
66 66 * in Jupyter's env (sys.prefix/share),
67 67 * per-user (~/.local/share or ~/Library/share)
68 68
69 You can also create configuration in temporary location and install it in Jupyter (copy configuration files) with:
69 In case where you want to edit generated kernelspec configuration before installing it you can do the same with two steps approach. You can create configuration in temporary location and install it in Jupyter (copy configuration files) with:
70 70
71 71 .. sourcecode:: bash
72 72
73 73 ipython kernel install --prefix /tmp
74 74 jupyter kernelspec install /tmp/share/jupyter/kernels/python3
75 75
76 **Deprecated:** You can also create configuration for new environment by new configuration's file in `~/.ipython/kernels/my_env/kernel.json` with following content::
77
78 {
79 "argv": ["~/path/to/env/bin/python", "-m", "IPython.kernel",
80 "-f", "{connection_file}"],
81 "display_name": "Python 3 (my new env)",
82 "language": "python"
83 }
84
85 Please note that kernel detection in standard ``~/.ipython/`` location is supported as part of backward-compatibility and may not be provided in further versions.
General Comments 0
You need to be logged in to leave comments. Login now