JupyterLab can be installed using
conda
, pip
, pipenv
or docker
.To start Jupyter Notebook in Windows: open a Windows cmd (win + R and return cmd) change directory to the desired file path (cd file-path) give command jupyter notebook; You can further navigate from the UI of Jupyter notebook after you launch it (if you are not directly launching the right file.)OR you can directly drag and drop the file to the cmd, to open the file. Jupyter Notebook is an open-source web application that allows you to create and share documents that contain live code, equations, visualizations, and narrative text. Uses include data cleaning and transformation, numerical simulation, statistical modeling, data visualization, machine learning, and much more.
conda¶
If you use
conda
, you can install it with:pip¶
If you use
pip
, you can install it with:If installing using
pipinstall--user
, you must add the user-levelbin
directory to your PATH
environment variable in order to launchjupyterlab
. If you are using a Unix derivative (FreeBSD, GNU / Linux,OS X), you can achieve this by using exportPATH='$HOME/.local/bin:$PATH'
command.pipenv¶
If you use
pipenv
, you can install it as:or from a git checkout:
When using
pipenv
, in order to launch jupyterlab
, you must activate the project’s virtualenv.For example, in the directory where pipenv
’s Pipfile
and Pipfile.lock
live (i.e., where you ran the above commands):Alternatively, you can run
jupyterlab
inside the virtualenv withDocker¶
If you have Docker installed, you can install and use JupyterLab by selecting oneof the many ready-to-run Docker imagesmaintained by the Jupyter Team. Follow the instructions in the Quick Start Guideto deploy the chosen Docker image. NOTE: Ensure your docker command includes the -e JUPYTER_ENABLE_LAB=yes flag to ensureJupyterLab is enabled in your container.
Installing with Previous Versions of Notebook¶
If you are using a version of Jupyter Notebook earlier than 5.3, then you must also run the following command to enable the JupyterLabserver extension:
Prerequisites¶
JupyterLab requires the Jupyter Notebook version 4.3 or later. To checkthe version of the
notebook
package that you have installed:Usage with JupyterHub¶
Read the details on our JupyterLab on JupyterHub documentation page.
Supported browsers¶
The latest versions of the following browsers are currently known to work:
Jupyter Download File
- Firefox
- Chrome
- Safari
Earlier browser versions may also work, but come with no guarantees.
JupyterLab uses CSS Variables for styling, which is one reason for theminimum versions listed above. IE 11+ or Edge 14 do not supportCSS Variables, and are not directly supported at this time.A tool like postcss can be used to convert the CSS files in the
jupyterlab/build
directory manually if desired.Usage with private NPM registry¶
To install extensions, you will need access to a NPM packages registry. Some companies do not allowreaching directly public registry and have a private registry. To use it, you need to configure
npm
andyarn
to point to that registry (ask your corporate IT department for the correct URL):JupyterLab will pick up that registry automatically.
Install Jupyter On Mac
Note
You can check which registry URL is used by JupyterLab by running:
Installation problems¶
If your computer is behind corporate proxy or firewall,you may encounter HTTP and SSL errors due to custom security profiles managed by corporate IT departments.
Example of typical error, when conda cannot connect to own repositories:
- CondaHTTPError: HTTP 000 CONNECTION FAILED for url <https://repo.anaconda.com/pkgs/main/win-64/current_repodata.json>
This may happen because your company can block connections to widely-used repositories in Python and JavaScript communities.
Here are some widely-used sites that host packages in the Python and JavaScript open-source ecosystem. Your network adminstrator may be able to allow http and https connections to these:
- *.pypi.org
- *.pythonhosted.org
- *.continuum.io
- *.anaconda.com
- *.conda.io
- *.github.com
- *.githubusercontent.com
- *.npmjs.com
- *.yarnpkg.com
Alternatively you can specify proxy user (mostly domain user with password),that is allowed to communicate via network. This can be easily achievedby setting two common environment variables: HTTP_PROXY and HTTPS_PROXY.These variables are automatically used by many open-source tools (like
conda
) if set correctly.In case you can communicate via HTTP, but installation with
conda
failson connectivity problems to HTTPS servers, you can disable using SSL for conda
.Warning
Disabling SSL in communication is generally not recommended and involves potential security risks.
You can do a similar thing for
pip
.The approach here is to mark repository servers as trusted hosts,which means, SSL communication will not be required for downloading Python libraries.Using the tips from above, you can handle many network problemsrelated to installing Python libraries.
Many Jupyter extensions require having a working
npm
and jlpm
(alias for yarn
) commands,which is required for downloading useful Jupyter extensions or other JavaScript dependencies.Example of typical error message, when
npm
cannot connect to own repositories:- ValueError: “@jupyterlab/toc” is not a valid npm package
In case you can communicate via HTTP, but installation with
npm
failson connectivity problems to HTTPS servers, you can disable using SSL for npm
.Warning
Install Jupyter Notebook On Mac
Disabling SSL in communication is generally not recommended and involves potential security risk.
Problems with Extensions and Settings¶
Jupyterlab saves settings via PUT requests to the server with a JSON5-compatible payload, even though it claims the PUT request is valid JSON. JSON5 is a superset of JSON that allows comments, etc. There may be deployment problems, manifest as 400 error return codes when saving settings, if these PUT requests are rejected by a routing layer that tries to validate the payload as JSON instead of JSON5.
Common symptoms of this during debugging are:
- The settings are selected but nothing changes, or when extension manager is enabled but the manager tab is not added.
- JupyterLab’s logs don’t have the 400 return codes when PUT requests are issued.
- If your JupyterLab logs are on Elastic Search, you’ll see Unexpected token / in JSON at position. This comes from the JSON5 comments not being valid JSON.