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 in beta.

JupyterLab is the next-generation user interface forProject Jupyter. It offersall the familiar building blocks of the classic Jupyter Notebook (notebook,terminal, text editor, file browser, rich outputs, etc.) in a flexible andpowerful user inteface.Eventually, JupyterLab will replace the classic Jupyter Notebook afterJupyterLab reaches 1.0.

JupyterLab can be extended using extensions that arenpm packagesand use our public APIs. You can search for the GitHub topicjupyterlab-extension to find extensions. To learn more about extensions, see ouruser documentation.

The beta releases are suitable for generalusage. For JupyterLab extension developers, the extension APIs will continue toevolve until the 1.0 release.

Read the latest version of our documentation onReadTheDocs.

You caninstall JupyterLab usingconda,pip, orpipenv.

Instructions on how to install the project from the git sources are available in ourcontributor documentation.

If you useconda, you can install as:

conda install -c conda-forge jupyterlab

If you usepip, you can install it as:

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 usepipenv, you can install it as:

pipenv install jupyterlabpipenv shell

or from a git checkout:

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

When usingpipenv, in order to launchjupyter lab, you must activate the project's virtualenv. For example, in the directory wherepipenv'sPipfile andPipfile.lock live (i.e., where you ran the above commands):

pipenv shelljupyter lab

If you are using a version of Jupyter Notebook earlier than 5.3, then you must also run the following commandafter installation to enable the JupyterLab server extension:

jupyter serverextensionenable --py jupyterlab --sys-prefix

Start up JupyterLab using:

jupyter lab

JupyterLab will open automatically in your browser. See ourdocumentation for additional details.

Jupyter notebook version 4.3 or later. To check the notebook version:

jupyter notebook --version

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

• Firefox
• Chrome
• Safari

See ourdocumentation for additional details.

If you would like to contribute to the project, please read ourcontributor documentation.

JupyterLab follows the officialJupyter Code of Conduct.

To start developing your own extension, see ourdevelopers documentation andAPI docs.

We use 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 of contributors. Our maintainer team is accompanied 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:

• Chris Colbert, Project Jupyter (co-creator, application/low-level architecture,technical leadership, vision, phosphor.js)
• Afshin Darian, Project Jupyter (co-creator, settings, inspector, completer,prolific contributions throughout the code base).
• Jessica Forde, Project Jupyter (demo, documentation)
• Tim George, Cal Poly (UI/UX design, strategy, management, user needs analysis)
• Brian Granger, Cal Poly (co-creator, strategy, vision, management, UI/UX design,architecture).
• Jason Grout, Bloomberg (co-creator, vision, general development).
• Fernando Perez, UC Berkeley (co-creator, vision).
• Ian Rose, UC Berkeley (Real-time collaboration, document architecture).
• Saul Shanabrook, Quansight (general development, extensions)
• Steven Silvester, JPMorgan Chase (co-creator, release management, packaging,prolific contributions throughout the code base).

Maintainer emeritus:

• Cameron Oelsen, Cal Poly (UI/UX design).

This list is provided to help provide context about who we are and how our team functions.If you would like to be listed, please submit a pull request with your information.

We encourage you to ask questions on themailing list,and you may participate in development discussions or get live help onGitter. Please use ourissues page to provide feedback or submit a bug report.