123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103 |
- .. _installation:
- Installation
- ------------
- JupyterLab can be installed using ``conda``, ``pip``, ``pipenv`` or ``docker``.
- conda
- ~~~~~
- If you use ``conda``, you can install it with:
- .. code:: bash
- conda install -c conda-forge jupyterlab
- pip
- ~~~
- If you use ``pip``, you can install it with:
- .. code:: bash
- pip install jupyterlab
- If installing using ``pip install --user``, you must add the user-level
- ``bin`` directory to your ``PATH`` environment variable in order to launch
- ``jupyter lab``.
- pipenv
- ~~~~~~
- If you use ``pipenv``, you can install it as:
- .. code:: bash
- pipenv install jupyterlab
- pipenv shell
- or from a git checkout:
- .. code:: bash
- pipenv install git+git://github.com/jupyterlab/jupyterlab.git#egg=jupyterlab
- pipenv shell
- When using ``pipenv``, in order to launch ``jupyter lab``, you must activate the project's virtualenv.
- For example, in the directory where ``pipenv``'s ``Pipfile`` and ``Pipfile.lock`` live (i.e., where you ran the above commands):
- .. code:: bash
- pipenv shell
- jupyter lab
- Docker
- ~~~~~~
- If you have `Docker installed <https://docs.docker.com/install/>`__, you can install and use JupyterLab by selecting one
- of the many `ready-to-run Docker images <https://jupyter-docker-stacks.readthedocs.io/en/latest/using/selecting.html>`__
- maintained by the Jupyter Team. Follow the instructions in the `Quick Start Guide <https://jupyter-docker-stacks.readthedocs.io/en/latest/>`__
- to deploy the chosen Docker image. NOTE: Ensure your docker command includes the `-e JUPYTER_ENABLE_LAB=yes` flag to ensure
- JupyterLab is enabled in your container.
- Installing with Previous Versions of Notebook
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- 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
- server extension:
- .. code:: bash
- jupyter serverextension enable --py jupyterlab --sys-prefix
- Prerequisites
- ~~~~~~~~~~~~~
- JupyterLab requires the Jupyter Notebook version 4.3 or later. To check
- the version of the ``notebook`` package that you have installed:
- .. code:: bash
- jupyter notebook --version
- Supported browsers
- ~~~~~~~~~~~~~~~~~~
- The latest versions of the following browsers are currently known to work:
- - Firefox
- - Chrome
- - Safari
- Earlier browser versions may also work, but come with no guarantees.
- JupyterLab uses CSS Variables for styling, which is one reason for the
- minimum versions listed above. IE 11+ or Edge 14 do not support
- CSS Variables, and are not directly supported at this time.
- A tool like `postcss <https://postcss.org/>`__ can be used to convert the CSS files in the
- ``jupyterlab/build`` directory manually if desired.
|