installation.rst 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  1. .. _installation:
  2. Installation
  3. ------------
  4. JupyterLab can be installed using ``conda``, ``pip``, or ``pipenv``.
  5. conda
  6. ~~~~~
  7. If you use ``conda``, you can install it with:
  8. .. code:: bash
  9. conda install -c conda-forge jupyterlab
  10. pip
  11. ~~~
  12. If you use ``pip``, you can install it with:
  13. .. code:: bash
  14. pip install jupyterlab
  15. If installing using ``pip install --user``, you must add the user-level
  16. ``bin`` directory to your ``PATH`` environment variable in order to launch
  17. ``jupyter lab``.
  18. pipenv
  19. ~~~~~~
  20. If you use ``pipenv``, you can install it as:
  21. .. code:: bash
  22. pipenv install jupyterlab
  23. pipenv shell
  24. or from a git checkout:
  25. .. code:: bash
  26. pipenv install git+git://github.com/jupyterlab/jupyterlab.git#egg=jupyterlab
  27. pipenv shell
  28. When using ``pipenv``, in order to launch ``jupyter lab``, you must activate the project's virtualenv.
  29. For example, in the directory where ``pipenv``'s ``Pipfile`` and ``Pipfile.lock`` live (i.e., where you ran the above commands):
  30. .. code:: bash
  31. pipenv shell
  32. jupyter lab
  33. Installing with Previous Versions of Notebook
  34. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35. If you are using a version of Jupyter Notebook earlier than 5.3, then you must also run the following command to enable the JupyterLab
  36. server extension:
  37. .. code:: bash
  38. jupyter serverextension enable --py jupyterlab --sys-prefix
  39. Prerequisites
  40. ~~~~~~~~~~~~~
  41. JupyterLab requires the Jupyter Notebook version 4.3 or later. To check
  42. the version of the ``notebook`` package that you have installed:
  43. .. code:: bash
  44. jupyter notebook --version
  45. Supported browsers
  46. ~~~~~~~~~~~~~~~~~~
  47. The latest versions of the following browsers are currently known to work:
  48. - Firefox
  49. - Chrome
  50. - Safari
  51. Earlier browser versions may also work, but come with no guarantees.
  52. JupyterLab uses CSS Variables for styling, which is one reason for the
  53. minimum versions listed above. IE 11+ or Edge 14 do not support
  54. CSS Variables, and are not directly supported at this time.
  55. A tool like `postcss <https://postcss.org/>`__ can be used to convert the CSS files in the
  56. ``jupyterlab/build`` directory manually if desired.