安装#

JupyterLab 可以作为通过网络浏览器访问的终端启动应用程序(默认),也可以作为在自己的窗口中运行并通过点击桌面快捷方式打开的桌面应用程序(JupyterLab 桌面版)进行安装。本页介绍了使用 condamambapippipenvdocker 安装默认(终端启动)JupyterLab 应用程序的方法,并假定您对终端有基本了解。有关 JupyterLab 桌面版的说明,请参阅 JupyterLab 桌面版仓库中的安装部分

警告

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

如果使用 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:PWD@proxy.company.com:PORT
set HTTPS_PROXY=https://USER:PWD@proxy.company.com:PORT

# For Linux / MacOS
export HTTP_PROXY=http://USER:PWD@proxy.company.com:PORT
export HTTPS_PROXY=https://USER:PWD@proxy.company.com: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:PWD@proxy.company.com:PORT
npm config set proxy https://USER:PWD@proxy.company.com: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