upstream/ipython Files · docs/source/install/kernel_install.rst

Merge pull request from jamesfe/issue_9085_deprecationfix...

Merge pull request from jamesfe/issue_9085_deprecationfix Undo Testing Deprecation Warning for onlyif_cmds_exist

Matthias Bussonnier - - Load All Authors

File last commit:

r21816:e5b01e24


                r21880:e188f4c7

Download file

             kernel_install.rst
        
                    62 lines
            
             | 2.0 KiB
            
                | text/x-rst
            
             |
                RstLexer
            
             / docs / source / install / kernel_install.rst
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Jonathan Frederic
    
Add files remove in https://github.com/jupyter/notebook/pull/124

              r21584
            
      .. _kernel_install:

        Min RK
    
document kernel installation in multiple environments

              r21710
            
      Installing the IPython kernel

      =============================

        Jonathan Frederic
    
Add files remove in https://github.com/jupyter/notebook/pull/124

              r21584
            
        Min RK
    
document kernel installation in multiple environments

              r21710
            
      IPython can be installed (different python versions, virtualenv or conda

      environments) as a kernel for Jupyter by following these steps:

      * make sure that the desired python installation is active

        (e.g. activate the environment, or use absolute paths)

        and ipykernel is installed

      * run once ``ipython kernel install --user``,

        or ``python -m ipykernel install --user`` to ensure a specific Python installation is used.

        Matthias Bussonnier
    
update install instruction

              r21815
            
      * See `ipython kernel install --help` for the list of installation options like

        naming the kernel, or non default install location.

      * The IPython kernel for Jupyter is provided by the `ipykernel` python package,

        Matthias Bussonnier
    
take comments into account

              r21816
            
        see `ipykernel documentation <http://ipykernel.readthedocs.org/>`_ if you

        need more flexibility for installation.

        Jonathan Frederic
    
Add files remove in https://github.com/jupyter/notebook/pull/124

              r21584
            
        Min RK
    
document kernel installation in multiple environments

              r21710
            
      For example:

      .. sourcecode:: bash

          source activate kernel-environment

          ipython kernel install --user

          source deactivate kernel-environment

      or

      .. sourcecode:: bash

          ~/envs/kernel-environment/python -m ipykernel install --user

        Matthias Bussonnier
    
take comments into account

              r21816
            
      The last command installs a :ref:`kernel spec <jupyterclient:kernelspecs>` file

      for the current python installation. Kernel spec files are JSON files, which

      can be viewed and changed with a normal text editor.

        Matthias Bussonnier
    
update install instruction

              r21815
            
      .. note ::

          The command `ipython kernelspec` is deprecated and will be removed in future versions.

        Min RK
    
document kernel installation in multiple environments

              r21710
            
      .. _multiple_kernel_install:

      Multiple IPython installs

      =========================

      If you want to have multiple IPython kernels for different environments,

      you will need to specify unique names for the kernelspecs,

      and you may also want to specify the display name of those kernels,

      so that you can clearly see which is which in the notebook menus:

      .. sourcecode:: bash

          source activate myenv

          ipython kernel install --user --name myenv --display-name "Python (myenv)"

          source activate other-env

          ipython kernel install --user --name other-env --display-name "Python (other-env)"

          source deactivate

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

Jonathan Frederic Add files remove in https://github.com/jupyter/notebook/pull/124	r21584	.. _kernel_install:

Min RK document kernel installation in multiple environments	r21710	Installing the IPython kernel
		=============================
Jonathan Frederic Add files remove in https://github.com/jupyter/notebook/pull/124	r21584
Min RK document kernel installation in multiple environments	r21710	IPython can be installed (different python versions, virtualenv or conda
		environments) as a kernel for Jupyter by following these steps:

		* make sure that the desired python installation is active
		(e.g. activate the environment, or use absolute paths)
		and ipykernel is installed
		* run once ``ipython kernel install --user``,
		or ``python -m ipykernel install --user`` to ensure a specific Python installation is used.
Matthias Bussonnier update install instruction	r21815	* See `ipython kernel install --help` for the list of installation options like
		naming the kernel, or non default install location.
		* The IPython kernel for Jupyter is provided by the `ipykernel` python package,
Matthias Bussonnier take comments into account	r21816	see `ipykernel documentation <http://ipykernel.readthedocs.org/>`_ if you
		need more flexibility for installation.
Jonathan Frederic Add files remove in https://github.com/jupyter/notebook/pull/124	r21584

Min RK document kernel installation in multiple environments	r21710	For example:

		.. sourcecode:: bash

		source activate kernel-environment
		ipython kernel install --user
		source deactivate kernel-environment

		or

		.. sourcecode:: bash

		~/envs/kernel-environment/python -m ipykernel install --user

Matthias Bussonnier take comments into account	r21816	The last command installs a :ref:`kernel spec <jupyterclient:kernelspecs>` file
		for the current python installation. Kernel spec files are JSON files, which
		can be viewed and changed with a normal text editor.


Matthias Bussonnier update install instruction	r21815	.. note ::

		The command `ipython kernelspec` is deprecated and will be removed in future versions.

Min RK document kernel installation in multiple environments	r21710
		.. _multiple_kernel_install:

		Multiple IPython installs
		=========================

		If you want to have multiple IPython kernels for different environments,
		you will need to specify unique names for the kernelspecs,
		and you may also want to specify the display name of those kernels,
		so that you can clearly see which is which in the notebook menus:

		.. sourcecode:: bash

		source activate myenv
		ipython kernel install --user --name myenv --display-name "Python (myenv)"
		source activate other-env
		ipython kernel install --user --name other-env --display-name "Python (other-env)"
		source deactivate