安装#

JupyterLab 可以安装为通过 Web 浏览器访问的终端启动应用程序(默认),也可以安装为在自己的窗口中运行的桌面应用程序,可以通过点击桌面快捷方式打开 (JupyterLab Desktop)。本页介绍使用 condamambapippipenvdocker 安装默认的(终端启动的)JupyterLab 应用程序,并假设您具备基本的终端知识。有关 JupyterLab Desktop 的说明,请参阅 JupyterLab Desktop 存储库中的 安装部分

警告

新版本的 JupyterLab 可能会破坏与扩展和其他 Jupyter 自定义的向后兼容性。如 向后兼容性、版本和重大更改 中所述,JupyterLab 的开发和发布周期遵循语义版本控制,因此我们建议您规划安装和升级流程,以考虑可能发生的重大更改,这些更改可能会中断您对 JupyterLab 和任何与您的工作流程至关重要的相关工具的使用。

conda#

如果您使用 conda,您可以使用以下命令安装它

conda install -c conda-forge jupyterlab

mamba#

如果您使用 mamba,您可以使用以下命令安装它

mamba install -c conda-forge jupyterlab

pip#

如果您使用 pip,您可以使用以下命令安装它

pip install jupyterlab

如果您使用的是附带 Python 2 的 macOS 版本,请运行 pip3 而不是 pip

如果使用 pip install --user 安装,您必须将用户级 bin 目录添加到您的 PATH 环境变量中,以便启动 jupyter lab。如果您使用的是 Unix 派生系统(FreeBSD、GNU/Linux、macOS),您可以通过运行 export PATH="$HOME/.local/bin:$PATH" 来实现。

pipenv#

如果您使用 pipenv,您可以将其安装为

pipenv install jupyterlab
pipenv shell

或从 git 检出

pipenv install git+git://github.com/jupyterlab/jupyterlab.git#egg=jupyterlab
pipenv shell

使用 pipenv 时,为了启动 jupyter lab,您必须激活项目的虚拟环境。例如,在 pipenvPipfilePipfile.lock 所在的目录(即您运行上述命令的目录)中

pipenv shell
jupyter lab

或者,您可以在虚拟环境中运行 jupyter lab,方法是

pipenv run jupyter lab

Docker#

如果您已安装 Docker,您可以通过选择 Jupyter 团队维护的众多 可运行 Docker 镜像 来安装和使用 JupyterLab。按照 快速入门指南 中的说明部署所选的 Docker 镜像。

确保您的 docker 命令包含 -e JUPYTER_ENABLE_LAB=yes 标志,以确保在您的容器中启用 JupyterLab。

与 JupyterHub 一起使用#

阅读我们 JupyterHub 上的 JupyterLab 文档页面 中的详细信息。

与 Jupyverse 一起使用#

Jupyverse 是一个基于 FastAPI 的下一代 Jupyter 服务器。它可以替代 jupyter-server,后者是 JupyterLab 默认安装的 Jupyter 服务器。请注意,jupyter-server 扩展无法与 jupyverse 一起使用(可能存在等效的插件)。

您可以使用 pip 安装 jupyverse

pip install jupyverse[auth, jupyterlab]

或使用 conda

conda install -c conda-forge jupyverse fps-auth fps-jupyterlab

或使用 mamba

mamba install -c conda-forge jupyverse fps-auth fps-jupyterlab

并使用以下命令运行它

jupyverse

支持的浏览器#

目前已知以下浏览器的最新版本可以正常工作

  • Firefox

  • Chrome

  • Safari

  • Edge

较早的浏览器版本也可能有效,但没有保证。

安装问题#

如果您的计算机位于公司代理或防火墙后面,您可能会遇到 HTTP 和 SSL 错误,因为代理或防火墙阻止了与广泛使用的服务器的连接。例如,如果 conda 无法连接到自己的存储库,您可能会看到此错误

CondaHTTPError: HTTP 000 CONNECTION FAILED for url <https://repo.anaconda.com/pkgs/main/win-64/current_repodata.json>

以下是一些广泛使用的网站,它们托管 Python 和 JavaScript 开源生态系统中的软件包。您的网络管理员可能能够允许对这些域进行 http 和 https 连接

  • pypi.org

  • pythonhosted.org

  • continuum.io

  • anaconda.com

  • conda.io

  • github.com

  • githubusercontent.com

  • npmjs.com

  • yarnpkg.com

或者,您可以指定一个代理用户(通常是具有密码的域用户),该用户被允许通过网络进行通信。这可以通过设置两个常见的环境变量轻松实现:HTTP_PROXYHTTPS_PROXY。如果设置正确,这些变量将被许多开源工具(如 conda)自动使用。

# For Windows
set HTTP_PROXY=http://USER:[email protected]:PORT
set HTTPS_PROXY=https://USER:[email protected]:PORT

# For Linux / MacOS
export HTTP_PROXY=http://USER:[email protected]:PORT
export HTTPS_PROXY=https://USER:[email protected]:PORT

如果您可以通过 HTTP 进行通信,但使用 conda 安装在连接到 HTTPS 服务器时遇到问题,您可以禁用 conda 的 SSL 使用。

警告

通常不建议在通信中禁用 SSL,这会带来潜在的安全风险。

# Configure npm to not use SSL
conda config --set ssl_verify False

您可以对 pip 做类似的事情。这里的方法是将存储库服务器标记为受信任的主机,这意味着下载 Python 库将不需要 SSL 通信。

# Install pandas (without SSL)
pip install --trusted-host pypi.org --trusted-host files.pythonhosted.org pandas

使用上述技巧,您可以处理与安装 Python 库相关的许多网络问题。

许多 Jupyter 扩展需要具有可用的 npmjlpmyarn 的别名)命令,这是下载有用的 Jupyter 扩展或其他 JavaScript 依赖项所必需的。如果 npm 无法连接到自己的存储库,您可能会看到类似的错误

ValueError: "@jupyterlab/toc" is not a valid npm package

您可以使用以下命令设置用于 npm 的代理或注册表。

# Set proxy for NPM
npm config set proxy http://USER:[email protected]:PORT
npm config set proxy https://USER:[email protected]:PORT

# Set default registry for NPM (optional, useful in case if common JavaScript libs cannot be found)
npm config set registry http://registry.npmjs.org/
jlpm config set npmRegistryServer https://registry.yarnpkg.com/

如果您可以通过 HTTP 进行通信,但使用 npm 安装时遇到连接到 HTTPS 服务器的问题,您可以禁用 npm 的 SSL。

警告

通常不建议在通信中禁用 SSL,这会带来潜在的安全风险。

# Configure npm to not use SSL
npm set strict-ssl False