Installation

Using pip

pip install ipyleaflet
jupyter nbextension enable --py --sys-prefix ipyleaflet  # can be skipped for notebook 5.3 and above

Using conda

conda install -c conda-forge ipyleaflet

JupyterLab extension

If you have JupyterLab <=2, you will also need to install the JupyterLab extension:

jupyter labextension install @jupyter-widgets/jupyterlab-manager jupyter-leaflet

Development installation

For a development installation (requires yarn):

git clone https://github.com/jupyter-widgets/ipyleaflet.git
cd ipyleaflet
pip install -e .

# If you are developing on Jupyter Notebook
jupyter nbextension install --py --symlink --sys-prefix --overwrite ipyleaflet
jupyter nbextension enable --py --sys-prefix --overwrite ipyleaflet

# If you are developing on JupyterLab
jupyter labextension develop . --overwrite

Note for developers:

• the -e pip option allows one to modify the Python code in-place. Restart the kernel in order to see the changes.

• the --symlink argument on Linux or OS X allows one to modify the JavaScript code in-place. This feature is not available with Windows.

  For automatically building the JavaScript code every time there is a change, run the following command from the ipyleaflet/js/ directory:

  yarn run watch