installation.rst 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  1. .. _installation:
  2. Installation
  3. ------------
  4. JupyterLab can be installed using ``conda``, ``pip``, ``pipenv`` or ``docker``.
  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. Docker
  34. ~~~~~~
  35. If you have `Docker installed <https://docs.docker.com/install/>`__, you can install and use JupyterLab by selecting one
  36. of the many `ready-to-run Docker images <https://jupyter-docker-stacks.readthedocs.io/en/latest/using/selecting.html>`__
  37. maintained by the Jupyter Team. Follow the instructions in the `Quick Start Guide <https://jupyter-docker-stacks.readthedocs.io/en/latest/>`__
  38. to deploy the chosen Docker image. NOTE: Ensure your docker command includes the `-e JUPYTER_ENABLE_LAB=yes` flag to ensure
  39. JupyterLab is enabled in your container.
  40. Installing with Previous Versions of Notebook
  41. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  42. 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
  43. server extension:
  44. .. code:: bash
  45. jupyter serverextension enable --py jupyterlab --sys-prefix
  46. Prerequisites
  47. ~~~~~~~~~~~~~
  48. JupyterLab requires the Jupyter Notebook version 4.3 or later. To check
  49. the version of the ``notebook`` package that you have installed:
  50. .. code:: bash
  51. jupyter notebook --version
  52. Supported browsers
  53. ~~~~~~~~~~~~~~~~~~
  54. The latest versions of the following browsers are currently known to work:
  55. - Firefox
  56. - Chrome
  57. - Safari
  58. Earlier browser versions may also work, but come with no guarantees.
  59. JupyterLab uses CSS Variables for styling, which is one reason for the
  60. minimum versions listed above. IE 11+ or Edge 14 do not support
  61. CSS Variables, and are not directly supported at this time.
  62. A tool like `postcss <https://postcss.org/>`__ can be used to convert the CSS files in the
  63. ``jupyterlab/build`` directory manually if desired.