The Elyra JupyterLab extension can be installed using pip
, conda
, or from source code.
Note: JupyterLab currently requires a re-build after installing any extension.
Note: Elyra 1.0.0 and above require JupyterLab 2.x.
If you use pip
, install Elyra with:
pip install --upgrade elyra && jupyter lab build
Note: Ubuntu and CentOS users may need to use pip3 install elyra
If you use conda
, install Elyra with:
conda install -c conda-forge elyra && jupyter lab build
To build Elyra from source code follow the instructions in developer guide.
To verify an Elyra installation review the installed server extensions and lab extensions.
Verify that the elyra
extension is installed.
jupyter serverextension list
Should output:
config dir: /usr/local/etc/jupyter
elyra enabled
- Validating...
elyra v1.2.0 OK
jupyterlab enabled
- Validating...
jupyterlab 2.2.2 OK
jupyterlab_git enabled
- Validating...
jupyterlab_git 0.21.1 OK
nbdime enabled
- Validating...
nbdime 2.0.0 OK
NOTE: If you don't see the elyra server extension enabled, you may need to explicitly enable it by running jupyter serverextension enable elyra
.
Verify that the elyra
labextensions are installed.
jupyter labextension list
Should output:
Known labextensions:
app dir: /.../share/jupyter/lab
@elyra/code-snippet-extension v1.2.0 enabled OK*
@elyra/metadata-extension v1.2.0 enabled OK*
@elyra/pipeline-editor-extension v1.2.0 enabled OK*
@elyra/python-editor-extension v1.2.0 enabled OK*
@elyra/theme-extension v1.2.0 enabled OK*
@jupyterlab/git v0.21.1 enabled OK
@jupyterlab/toc v4.0.0 enabled OK
nbdime-jupyterlab v2.0.0 enabled OK
If you have Docker installed, you can use JupyterLab and Elyra by running one of the ready-to-run Docker images maintained by the Elyra Team:
elyra/elyra:latest
has the latest released version installed.elyra/elyra:x.y.z
has versionx.y.z
installed.elyra/elyra:dev
is automatically re-built each time a change is committed to the master branch.
Invocation example 1: Run the most recent Elyra development build in a Docker container. All changes are discarded when the Docker container is stopped.
docker run -it -p 8888:8888 elyra/elyra:1.2.0 jupyter lab --debug
Invocation example 2: Run the most recent Elyra development build in a Docker container and mount the existing local $HOME/jupyter-notebooks/
directory as JupyterLab work directory. This enables you to make existing notebooks and other files available in the Docker container. Only files in this working directory are retained when the Docker container is stopped.
docker run -it -p 8888:8888\
-v ${HOME}/jupyter-notebooks/:/home/jovyan/work\
-w /home/jovyan/work\
elyra/elyra:1.2.0 jupyter lab --debug
Invocation example 3: Same as above. In addition a local directory named ${HOME}/jupyter-data-dir
is mounted as the Jupyter data directory in the Docker container, storing all user-defined Elyra metadata artifacts you might create, such as code snippets, runtime configurations, or runtime images.
Note: To start with a clean environment ${HOME}/jupyter-data-dir
should refer to an empty directory. To re-use an existing Jupyter data directory from a local installation specify the output of jupyter --data-dir
as directory name.
docker run -it -p 8888:8888\
-v ${HOME}/jupyter-notebooks/:/home/jovyan/work\
-w /home/jovyan/work\
-v ${HOME}/jupyter-data-dir:/home/jovyan/.local/share/jupyter\
elyra/elyra:1.2.0 jupyter lab --debug
Open the displayed URL in your browser to start using JupyterLab and Elyra.
To access the notebook, open this file in a browser:
file:///home/jovyan/.local/share/jupyter/runtime/nbserver-6-open.html
Or copy and paste one of these URLs:
http://4d17829ecd4c:8888/?token=d690bde267ec75d6f88c64a39825f8b05b919dd084451f82
or http://127.0.0.1:8888/?token=d690bde267ec75d6f88c64a39825f8b05b919dd084451f82
JupyterLab and Elyra are included in the Open Data Hub community operator. Follow the instructions in this document to deploy the operator in a Red Hat OpenShift cluster.