Skip to main content

PyPI version Anaconda-Server Badge Downloads Documentation Status GitHub OpenSSF Best Practices Gitter

Elyra

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

Elyra currently includes the following functionality:

Elyra

The Elyra Getting Started Guide includes more details on these features. A version-specific summary of new features is located on the releases page.

Try Elyra

Using container images

You can also try Elyra by running one of the container images from Docker Hub or quay.io:

  • elyra/elyra:latest has the latest released version installed.
  • elyra/elyra:x.y.z has a specific version installed.

Note: You can also build a container image from the main branch ("dev build") to try out features that have not been released yet.

To run one of the container images, issue the following command, specifying a tag of your choice.

docker run -it -p 8888:8888 elyra/elyra:4.2.0 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:4.2.0 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

Refer to the installation documentation for details.

Installation

For detailed information refer to the installation documentation.

Prerequisites :

Install current release (for JupyterLab 4.x)

The current release version is displayed at the top of this page.

  • Install from PyPI

    pip3 install --upgrade "elyra[all]"
    
  • Install from conda-forge

    conda install -c conda-forge "elyra[all]"
    

Install older release

Installation instructions and JupyterLab support vary by release. Note that a JupyterLab build is required. Installation instructions are located in the release-specific documentation, which can be accessed by selecting a specific version.

Elyra 4.x (JupyterLab 4.2.5+)
  • Install from PyPI

    pip3 install --upgrade "elyra[all]"
    
  • Install from conda-forge

    conda install -c conda-forge "elyra[all]"
    
Elyra 3.7 < 4.0 (JupyterLab 3.x)
  • Install from PyPI

    pip3 install --upgrade "elyra[all]<4.0.0"
    
  • Install from conda-forge

    conda install -c conda-forge "elyra[all]<4.0.0"
    
Elyra 3.1 < 3.7 (JupyterLab 3.x)
  • Install from PyPI

    pip3 install --upgrade "elyra[all]>=3.1.0" && jupyter lab build
    
  • Install from conda-forge

    conda install -c conda-forge "elyra[all]>=3.1.0" && jupyter lab build
    
Elyra 2.0 < 3.1 (JupyterLab 3.x)
  • Install from PyPI

    pip3 install --upgrade "elyra>=2.0.1" && jupyter lab build
    
  • Install from conda-forge

    conda install -c conda-forge "elyra>=2.0.1" && jupyter lab build
    

Verify Installation

Run the following commands to verify the installation. Note that in the example output below the [version] placeholder is displayed instead of an actual version identifier, which might change with every release.

jupyter server extension list

Should output:

Config dir: /.../.jupyter

Config dir: /.../etc/jupyter
    elyra enabled
    - Validating elyra...
      elyra  OK
    jupyter_lsp enabled
    - Validating jupyter_lsp...
      jupyter_lsp [version] OK
    jupyter_resource_usage enabled
    - Validating jupyter_resource_usage...
      jupyter_resource_usage [version] OK
    jupyter_server_mathjax enabled
    - Validating jupyter_server_mathjax...
      jupyter_server_mathjax  OK
    jupyterlab enabled
    - Validating jupyterlab...
      jupyterlab [version] OK
    jupyterlab_git enabled
    - Validating jupyterlab_git...
      jupyterlab_git [version] OK
    nbclassic enabled
    - Validating nbclassic...
      nbclassic  OK
    nbdime enabled
    - Validating nbdime...
      nbdime [version] OK

Config dir: /.../etc/jupyter

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

jupyter labextension list

Should output:

JupyterLab [version]
/.../share/jupyter/labextensions
        nbdime-jupyterlab [version] enabled OK
        @jupyter-server/resource-usage [version] enabled OK (python, jupyter-resource-usage)
        @jupyter-lsp/jupyterlab-lsp [version] enabled OK (python, jupyterlab-lsp)
        @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/scala-editor-extension [version] enabled OK
        @elyra/r-editor-extension [version] enabled OK
        @elyra/theme-extension [version] enabled OK
        @jupyterlab/git [version] enabled OK (python, jupyterlab-git-core)

Other labextensions (built into JupyterLab)
   app dir: /.../share/jupyter/lab

Starting Elyra

After verifying Elyra has been installed, start Elyra with:

jupyter lab

Getting Help

We welcome your questions, ideas, and feedback. Check the Getting Help section in the Getting Started guide to learn more about the channels you can use to get in touch with us.

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.

Meetup with Us!

Our daily and weekly community meeting schedule can be found here.

Metadata

Release files for elyra-server 4.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for elyra-server 4.2.0
File Size Uploaded Provenance Actions
elyra_server-4.2.0.tar.gz 381.1 kB Without provenance Details for elyra_server-4.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for elyra-server 4.2.0
File Interpreter ABI Platform Actions
elyra_server-4.2.0-py3-none-any.whl Python 3 none any Details for elyra_server-4.2.0-py3-none-any.whl

Total release size: 691.4 kB

Release files / elyra_server-4.2.0.tar.gz

Download URL elyra_server-4.2.0.tar.gz
Size 381.1 kB
Tags Source
SHA-256 checksum
How to use checksums
058e23dcb05beb33af64f6237a6e48259d82d2b6a71a98f0e3d13c5fa7f9f865
BLAKE2b-256 checksum
How to use checksums
3a4f75292766603220068da36abd43368edb2ee011926ddba597ea49a37b02b7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.15.2

Release files / elyra_server-4.2.0-py3-none-any.whl

Download URL elyra_server-4.2.0-py3-none-any.whl
Size 310.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a96d96bc60521c9e404c351fea311a58142eec5abdc771ace36d402acdf9adb8
BLAKE2b-256 checksum
How to use checksums
19d4af03c6a3345f1f6b86765a1b4a915e441ae4e1534acb0fa2e01496221abd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.15.2

Security for elyra-server 4.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

4.2.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page