Skip to content
master
Go to file
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time

README.md

PyPI version Downloads Documentation Status GitHub Gitter

Elyra

Elyra is a set of AI-centric extensions to JupyterLab Notebooks.

Elyra currently includes:

  • Notebook Pipelines visual editor
  • Ability to run notebooks as batch jobs
  • Reusable Code Snippets
  • Hybrid runtime support (based on Jupyter Enterprise Gateway)
  • Python script execution capabilities within the editor
  • Python script navigation using auto-generated outlines using Table of Contents
  • Notebook navigation using auto-generated Table of Contents
  • Notebook versioning based on Git integration
  • Reusable configuration and editor for runtimes

Elyra

The Elyra Getting Started Guide includes more details on these features.

Try Elyra

Using Binder

You can try out some of Elyra features using the My Binder service.

Click on a link below to try Elyra, on a sandbox environment, without having to install anything.

  • Launch latest stable version (Latest stable version - see changelog for recent updates)
  • Launch latest development version (Development version - expect longer image load time due to just-in-time build)

Using Docker

You can also try Elyra by running one of the docker images from Docker Hub:

  • elyra/elyra:latest has the latest released version installed.
  • elyra/elyra:x.y.z has a specific version installed.
  • elyra/elyra:dev is automatically re-built each time a change is committed to the master branch.

The command below starts the most recent development build in a clean environment:

docker run -it -p 8888:8888 elyra/elyra:dev jupyter lab --debug

To make a local directory containing your Notebooks (e.g. ${HOME}/opensource/jupyter-notebooks/) available in your docker container, you can use a mount command similar to the following:

docker run -it -p 8888:8888 -v ${HOME}/opensource/jupyter-notebooks/:/home/jovyan/work -w /home/jovyan/work elyra/elyra:dev jupyter lab --debug

These should produce output similar to that below, where you can then find the URL to be used to access Elyra in your local browser.

    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

Installation

Elyra can be installed via PyPi:

Prerequisites :

Optional :

JupyterLab support

  • JupyterLab 1.x is supported on Elyra 0.10.x and below

via PyPi:

pip install elyra==0.10.3 && jupyter lab build
  • JupyterLab 2.x is supported on Elyra 1.0.0 and above

via PyPi:

pip install --upgrade elyra && jupyter lab build

Note: Ubuntu and CentOS users may need to use pip3 install elyra

using Conda:

conda install -c conda-forge elyra && jupyter lab build

Verify Installation

jupyter serverextension list

Should output:

config dir: /usr/local/etc/jupyter
    elyra  enabled
    - Validating...
      elyra <VERSION> 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
jupyter labextension list

Should output:

Known labextensions:
   app dir: /.../share/jupyter/lab
        @elyra/code-snippet-extension <VERSION>  enabled  OK*
        @elyra/metadata-extension <VERSION>  enabled  OK*
        @elyra/pipeline-editor-extension <VERSION>  enabled  OK*
        @elyra/python-editor-extension <VERSION>  enabled  OK*
        @elyra/theme-extension <VERSION>  enabled  OK*
        @jupyterlab/git v0.21.1  enabled  OK
        @jupyterlab/toc v4.0.0  enabled  OK
        nbdime-jupyterlab v2.0.0  enabled  OK

NOTE: If you don't see the Elyra server extension enabled, you may need to explicitly enable it with jupyter serverextension enable elyra

Configuring Runtimes for Pipeline execution

The Elyra Pipeline editor delegates execution of pipelines to remote runtimes. Configure these external runtimes as documented in Runtime Configuration.

Starting Elyra

After verifying Elyra has been installed, start Elyra with:

jupyter lab

Contributing to Elyra

If you are interested in helping make Elyra better, we encourage you to take a look at our Contributing page,
Development Workflow documentation, and invite you to attend our weekly dev community meetings.

Weekly Dev Community Meeting

Join us weekly to discuss Elyra development topics. Everyone is welcome and participation is optional.

When: Thursdays at 9AM Pacific

Where: Webex

What: Meeting Notes

You can’t perform that action at this time.