Repository files navigation

Installation |Documentation |Contributing |License |Team |Getting help |

An extensible environment for interactive and reproducible computing, based on theJupyter Notebook and Architecture.Currently ready for users.

JupyterLab is the next-generation user interface forProject Jupyter offeringall the familiar building blocks of the classic Jupyter Notebook (notebook,terminal, text editor, file browser, rich outputs, etc.) in a flexible andpowerful user interface.JupyterLab will eventually replace the classic Jupyter Notebook.

JupyterLab can be extended usingnpm packagesthat use our public APIs. To find JupyterLab extensions, search for the npm keywordjupyterlab-extension or the GitHub topicjupyterlab-extension. To learn more about extensions, see theuser documentation.

The current JupyterLab releases are suitable for generalusage, and the extension APIs will continue toevolve for JupyterLab extension developers.

Read the current JupyterLab documentation onReadTheDocs.

JupyterLab can be installed usingconda orpip. For more detailed instructions, consult theinstallation guide.

Project installation instructions from the git sources are available in thecontributor documentation.

If you useconda, you can install it with:

conda install -c conda-forge jupyterlab

If you usepip, you can install it with:

pip install jupyterlab

If installing usingpip install --user, you must add the user-levelbin directory to yourPATH environment variable in order to launchjupyter lab. If you are using a Unix derivative (FreeBSD, GNU / Linux, OS X), you can achieve this by usingexport PATH="$HOME/.local/bin:$PATH" command.

When using a version of Jupyter Notebook earlier than 5.3, the following command must be runafter installation to enable the JupyterLab server extension:

jupyter serverextensionenable --py jupyterlab --sys-prefix

Start up JupyterLab using:

jupyter lab

JupyterLab will open automatically in the browser. See thedocumentation for additional details.

If you encounter an error like "Command 'jupyter' not found", please make surePATH environment variable is set correctly. Alternatively, you can start up JupyterLab using~/.local/bin/jupyter lab without changing thePATH environment variable.

The latest versions of the following browsers are currentlyknown to work:

• Firefox
• Chrome
• Safari

See ourdocumentation for additional details.

We encourage you to ask questions on theDiscourse forum. A question answered there can become a useful resource for others.

To report a bug please read theguidelines and then open aGithub issue. To keep resolved issues self-contained, thelock bot will lock closed issues as resolved after a period of inactivity. If related discussion is still needed after an issue is locked, please open a new issue and reference the old issue.

We also welcome suggestions for new features as they help make the project more useful for everyone. To request a feature please use thefeature request template.

To start developing an extension for JupyterLab, see thedeveloper documentation and theAPI docs.

To contribute code or documentation to JupyterLab itself, please read thecontributor documentation.

JupyterLab follows the JupyterCommunity Guides.

JupyterLab uses a shared copyright model that enables all contributors to maintain thecopyright on their contributions. All code is licensed under the terms of the revisedBSD license.

JupyterLab is part ofProject Jupyter and is developed by an open community. The maintenance team is assisted by a much larger group of contributors to JupyterLab and Project Jupyter as a whole.

JupyterLab's current maintainers are listed in alphabetical order, with affiliation, and main areas of contribution:

• Mehmet Bektas, Bloomberg (general development, extensions).
• Alex Bozarth, IBM (general development, extensions).
• Eric Charles, Datalayer, (general development, extensions).
• Martha Cryan, IBM (general development, extensions).
• Afshin Darian, Two Sigma (co-creator, application/high-level architecture,prolific contributions throughout the code base).
• Vidar T. Fauske, JPMorgan Chase (general development, extensions).
• Tim George, Cal Poly (UI/UX design, strategy, management, user needs analysis)
• Brian Granger, AWS (co-creator, strategy, vision, management, UI/UX design,architecture).
• Jason Grout, Bloomberg (co-creator, vision, general development).
• Max Klein, JPMorgan Chase (UI Package, build system, general development, extensions).
• Fernando Perez, UC Berkeley (co-creator, vision).
• Ian Rose, Quansight/City of LA (general core development, extensions).
• Andrew Schlaepfer, Bloomberg (general development, extensions).
• Saul Shanabrook, Quansight (general development, extensions)
• Steven Silvester, Apple (co-creator, release management, packaging,prolific contributions throughout the code base).

Maintainer emeritus:

• Chris Colbert, Project Jupyter (co-creator, application/low-level architecture,technical leadership, vision, PhosphorJS)
• Jessica Forde, Project Jupyter (demo, documentation)
• Cameron Oelsen, Cal Poly (UI/UX design).

This list is provided to give the reader context on who we are and how our team functions.To be listed, please submit a pull request with your information.

We have videoconference meetings every week where we discuss what we have been working on and get feedback from one another.

Anyone is welcome to attend, if they would like to discuss a topic or just to listen in.

• When: Wednesdays9AM Pacific Time
• Where:jovyan Zoom
• What:Meeting notes