• Stars
    star
    3,616
  • Rank 12,250 (Top 0.3 %)
  • Language
    TypeScript
  • License
    BSD 3-Clause "New...
  • Created over 7 years ago
  • Updated 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

JupyterLab desktop application, based on Electron.

JupyterLab Desktop

JupyterLab Desktop is the cross-platform desktop application for JupyterLab. It is the quickest and easiest way to get started with Jupyter notebooks on your personal computer, with the flexibility for advanced use cases.

JupyterLab Desktop

Installation

Install JupyterLab Desktop using one of the methods listed below for your system.

Windows (10, 11) Mac (macOS 10.15+) Linux
x64 Installer arm64 Installer (Apple silicon) Snap Store [recommended]
x64 Installer (Intel chip) .deb x64 Installer (Debian, Ubuntu)
.rpm x64 Installer (Red Hat, Fedora, SUSE)

Additionally, JupyterLab Desktop can be installed on Windows via winget: winget install jupyterlab.

If you need to remove a previous JupyterLab Desktop installation, please follow the uninstall instructions.

Launching JupyterLab Desktop

JupyterLab Desktop can be launched from the GUI of your operating system by clicking the application's icon or by using jlab command from the command line. Double clicking .ipynb files is also supported and it will launch JupyterLab Desktop and load the notebook file.

JupyterLab Desktop sets File Browser's root directory based on the launch method.

  • If launched from the application icon on GUI or by using jlab command without any arguments, then the default working directory is set as the root directory. The default working directory is user home directory but it can be customized from the Settings dialog.
  • If launched by double clicking .ipynb file or jlab command with a file path as the argument, then file's parent directory is set as the root directory. Similarly, if a file is opened using the Open... or Open File... links in the Start section or by using drag & drop, then file's parent directory is set as the root directory.
  • If jlab command is used with a directory path as the argument or with the --working-dir argument then the directory in the argument is set as the root directory. Similarly, if a folder is opened using the Open Folder... link in the Start section or by using drag & drop, then the opened directory is set as the root directory

Sessions and Projects

Sessions represent local project launches and connections to existing JupyterLab servers. Each JupyterLab UI window in the app is associated with a separate session and sessions can be restored with the same configuration later on.

Each launch of JupyterLab in a different working directory is a separate project and projects can have their own configuration such as Python environment and UI layout.

Session start options

You can start a new session by using the links at the Start section of the Welcome Page.

Start session

  • New notebook... creates a new notebook in the default working directory.
  • New session... launches a new JupyterLab session in the default working directory.
  • Open... starts a new JupyterLab session in the selected working directory. If files are chosen, selected files' parent directory becomes the working directory and selected files are opened in the session. On Windows and Linux Open Folder... and Open Files... options are presented as separate items.
  • Connect... creates a session by connecting to an existing JupyterLab server running locally or remotely. Locally running JupyterLab servers are automatically detected and listed in the Connect dialog.

Similarly, CLI launches of the application, dropping files and folders, and double clicking to open files create new sessions as well.

Previously opened sessions are stored as part of application data and they are listed on Welcome Page. Clicking an item in the Recent sessions list restores the selected session.

Recent sessions

jlab command-line launch examples

  • Open directories using relative or absolute path
    • jlab . launch in current directory
    • jlab ../notebooks launch with relative path
    • jlab /Users/username/notebooks launch with absolute path
  • Open notebooks and other files using relative or absolute path
    • jlab /Users/username/notebooks/test.ipynb launch notebook with absolute path
    • jlab ../notebooks/test.ipynb launch notebook with relative path
    • jlab ../test.py launch python file with relative path
  • Open with a custom Python environment
    • jlab --python-path /Users/username/custom_env/bin/python ../notebooks/test.ipynb launch notebook with custom Python environment
  • Connect to existing JupyterLab server
    • jlab https://example.org/lab?token=abcde

See CLI documentation for more CLI commands and options.

JupyterLab Extension support

JupyterLab Desktop currently supports user-friendly prebuilt extensions. Source extensions which require rebuilding are not supported.

Guides and Help

More Repositories

1

jupyterlab

JupyterLab computational environment.
TypeScript
14,050
star
2

jupyter-ai

A generative AI extension for JupyterLab
Python
3,132
star
3

jupyterlab-git

A Git extension for JupyterLab
TypeScript
1,453
star
4

jupyterlab-toc

Table of Contents extension for JupyterLab
TypeScript
726
star
5

jupyterlab-latex

JupyterLab extension for live editing of LaTeX documents
TypeScript
626
star
6

lumino

Lumino is a library for building interactive web applications
TypeScript
612
star
7

debugger

A visual debugger for Jupyter notebooks, consoles, and source files
TypeScript
562
star
8

jupyter-renderers

Renderers and renderer extensions for JupyterLab
HTML
488
star
9

extension-examples

JupyterLab Extensions by Examples
TypeScript
443
star
10

jupyterlab-github

GitHub integration for JupyterLab
TypeScript
412
star
11

jupyterlab-google-drive

Cloud storage for JupyterLab using Google Drive
TypeScript
400
star
12

retrolab

JupyterLab distribution with a retro look and feel 🌅
Jupyter Notebook
282
star
13

jupyterlab-monaco

A JupyterLab extension providing the Monaco editor
TypeScript
237
star
14

jupyterlab-demo

Demonstrations of JupyterLab
Jupyter Notebook
184
star
15

extension-cookiecutter-ts

A cookiecutter recipe for JupyterLab extensions in Typescript
CSS
179
star
16

jupyterlab-data-explorer

First class datasets in JupyterLab
TypeScript
178
star
17

jupyter-collaboration

A Jupyter Server Extension Providing Support for Y Documents
Jupyter Notebook
163
star
18

jupyterlab_server

A set of server components for JupyterLab and JupyterLab like applications
Python
139
star
19

jupyterlab-hdf5

Open and explore HDF5 files in JupyterLab. Can handle very large (TB) sized files, and datasets of any dimensionality
Jupyter Notebook
115
star
20

jupyterlab-celltags

A JupyterLab extension for notebook cell tags
TypeScript
113
star
21

jupyterlab-commenting

Commenting and annotation for JupyterLab
Jupyter Notebook
101
star
22

language-packs

Language packs for JupyterLab ecosystem
Python
78
star
23

scipy2018-jupyterlab-tutorial

Tutorial material and instruction for scipy 2018 jupyterlab tutorial
Jupyter Notebook
73
star
24

frontends-team-compass

A repository for team interaction, syncing, and handling meeting notes across the JupyterLab ecosystem.
58
star
25

extension-cookiecutter-js

A cookiecutter recipe for building JupyterLab extensions.
Python
55
star
26

jupyterlab-shortcutui

A JupyterLab extension for managing keyboard shortcuts
TypeScript
54
star
27

scipy2019-jupyterlab-tutorial

Scipy 2019 JupyterLab tutorial
Jupyter Notebook
51
star
28

extension-template

A `copier` template for JupyterLab extensions
Jinja
51
star
29

jupyterlab-statusbar

A status bar for JupyterLab
TypeScript
49
star
30

theme-cookiecutter

A cookiecutter template to help you make new JupyterLab theme extensions
CSS
49
star
31

jupyterlab-plugin-playground

A dynamic extension loader for JupyterLab
TypeScript
47
star
32

jupyterlab_pygments

Pygments theme making use of JupyterLab CSS variables
Python
39
star
33

hatch-jupyter-builder

A hatch plugin to help build Jupyter packages
Python
38
star
34

pull-requests

A JupyterLab extension for reviewing GitHub pull requests
Python
37
star
35

jupyterlab_xkcd

Random xkcd comic in a JupyterLab panel
TypeScript
31
star
36

galata

JupyterLab UI Testing Framework
JavaScript
30
star
37

jupyterlab-metadata-service

Linked data exploration in JupyterLab.
TypeScript
29
star
38

jupyterlab-telemetry

A JupyterLab extension for logging and telemetry of usage data
TypeScript
29
star
39

jupyterlab_apod

JupyterLab extension tutorial answer key. Please see the tutorial at https://jupyterlab.readthedocs.io/en/stable/extension/extension_tutorial.html
TypeScript
23
star
40

jupytercon-jupyterlab-tutorial

JupyterCon 2018 JupyterLab tutorial
Jupyter Notebook
22
star
41

mimerender-cookiecutter-ts

Cookie cutter for JupyterLab mimerenderer extensions using TypeScript
Python
19
star
42

pytest-check-links

pytest plugin that checks URLs
Python
17
star
43

jupyterlab-mp4

Example mimerenderer extension for showing mp4 videos.
TypeScript
17
star
44

mimerender-cookiecutter

A cookiecutter for rendering MIME type based output
Python
15
star
45

jupyter-chat

An extension to add a chat panel to JupyterLab
TypeScript
14
star
46

ui-profiler

Extension for profiling performance of JupyterLab UI for JupyterLab core developers, extension developers, and advanced users.
TypeScript
13
star
47

benchmarks

Benchmarking tools for JupyterLab
Jupyter Notebook
12
star
48

maintainer-tools

Workflows and Actions meant to be used by other repositories to make repo maintenance easier
Python
11
star
49

runall-extension

Add a "Run All Cells" toolbar button, context menu item, and keyboard shortcut.
TypeScript
8
star
50

jupyterlab-media

Repository storing movies and other media for JupyterLab tutorials and documentation
8
star
51

vscode-config-template

A copier template for creating the IDE config needed to debug the Python and Typescript code in any Jupyter project
Dockerfile
8
star
52

jupytercon-jupyterlab-training

JupyterCon 2018 JupyterLab Training
7
star
53

jupyterlab-translate

JupyterLab Language pack helper
Python
7
star
54

richoutput-js

Experimental investigation into a rendermime for es6 modules rendering rich output
Jupyter Notebook
7
star
55

jupyterlab-module-federation

Experimental playground for a JupyterLab extension system based on Module Federation
Python
5
star
56

jupyterlab-bot

JupyterLab Bot
Python
5
star
57

jupyterlab-probot

A probot for JupyterLab development
TypeScript
3
star
58

language-pack-cookiecutter

Template for Jupyterlab Language packs
Jinja
3
star
59

ux-research

3
star
60

.github

Community health files for the @JupyterLab organization
1
star
61

jupyter-builder

Build tools for JupyterLab (and remixes)
Python
1
star