Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve repository README #2835

Merged
merged 9 commits into from
Aug 10, 2022
113 changes: 62 additions & 51 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,14 +55,15 @@ Click on a link below to try Elyra, on a sandbox environment, without having to
- [![Launch latest stable version](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/elyra-ai/elyra/v3.10.0?urlpath=lab/tree/binder-demo) (Latest stable version - see the [releases page](https://github.com/elyra-ai/elyra/releases) for a new features summary)
- [![Launch latest development version](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/elyra-ai/elyra/main?urlpath=lab/tree/binder-demo) (Development version - expect longer image load time due to just-in-time build)

#### Using Docker
#### Using container images

You can also try Elyra by running one of the docker images from [Docker Hub](https://hub.docker.com/r/elyra/elyra/tags):
You can also try Elyra by running one of the container images from [Docker Hub](https://hub.docker.com/r/elyra/elyra/tags) or [quay.io](https://quay.io/repository/elyra/elyra?tab=tags):
- `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 main branch.

The command below starts the most recent development build in a clean environment:
Note: You can also [build a container image from the `main` branch ("dev build")](https://github.com/elyra-ai/elyra/tree/main/etc/docker/elyra) 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:dev jupyter lab --debug
Expand All @@ -75,8 +76,7 @@ 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.
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:
Expand All @@ -86,73 +86,84 @@ to access Elyra in your local browser.
or http://127.0.0.1:8888/?token=d690bde267ec75d6f88c64a39825f8b05b919dd084451f82
```

Refer to the [installation documentation](https://elyra.readthedocs.io/en/stable/getting_started/installation.html#docker) for details.

## Installation
Elyra can be installed from PyPI:

For detailed information refer to the [installation documentation](https://elyra.readthedocs.io/en/stable/getting_started/installation.html).

### Prerequisites :
* [NodeJS 16+](https://nodejs.org/en/)
* [Node.js 16+](https://nodejs.org/en/)
* [Python 3.7+](https://www.python.org/downloads/)
* [Miniconda](https://docs.conda.io/en/latest/miniconda.html) (optional)

### Install current release (for JupyterLab 3.x)

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

- Install from PyPI

```bash
pip3 install --upgrade "elyra[all]"
```

##### Optional :
* [Miniconda](https://docs.conda.io/en/latest/miniconda.html)
- Install from conda-forge

#### JupyterLab support
```bash
conda install -c conda-forge "elyra[all]"
```

* [JupyterLab](https://github.com/jupyterlab/jupyterlab) 3.x is supported on **Elyra 2.0.0 and above**
### Install older release

Install Elyra from PyPI ( Elyra >= 3.7.0 ):
Installation instructions and JupyterLab support vary by release. Note that a JupyterLab build is required. Installation instructions are located in the [release-specific documentation](https://elyra.readthedocs.io/en/stable/), which can be accessed by selecting a specific version.

```bash
pip3 install --upgrade "elyra[all]>=3.7.0"
```
<details>
<summary>Elyra 3.1 < 3.7 (JupyterLab 3.x)</summary>

Install fom Conda ( Elyra >= 3.7.0 ):
```bash
conda install -c conda-forge "elyra[all]>=3.7.0"
```
- Install from PyPI

* For versions of Elyra prior to 3.7 `jupyter lab build` must be run after install to enable the extensions.
```bash
pip3 install --upgrade "elyra[all]>=3.1.0" && jupyter lab build
```

Install Elyra from PyPI ( Elyra >= 3.1.0 ):
- Install from conda-forge

```bash
pip3 install --upgrade "elyra[all]>=3.1.0" && jupyter lab build
```
```bash
conda install -c conda-forge "elyra[all]>=3.1.0" && jupyter lab build
```
</details>

Install fom Conda ( Elyra >= 3.1.0 ):
```bash
conda install -c conda-forge "elyra[all]>=3.1.0" && jupyter lab build
```
<details>
<summary>Elyra 2.0 < 3.1 (JupyterLab 3.x)</summary>

Install Elyra from PyPI ( Elyra < 3.1.0 ):
- Install from PyPI

```bash
pip3 install --upgrade "elyra>=2.0.1" && jupyter lab build
```

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

Install fom Conda ( Elyra < 3.1.0 ):
```bash
conda install -c conda-forge "elyra>=2.0.1" && jupyter lab build
```
```bash
conda install -c conda-forge "elyra>=2.0.1" && jupyter lab build
```
</details>

* [JupyterLab](https://github.com/jupyterlab/jupyterlab) 2.x is supported on **Elyra 1.0.0 and above**
<details>
<summary>Elyra 1.0 < 2.0 (JupyterLab 2.x)</summary>

Install from PyPI:
```bash
pip3 install --upgrade "elyra<2.0.0" && jupyter lab build
```
- Install from PyPI

Install from Conda:
```bash
conda install -c conda-forge "elyra<2.0.0" && jupyter lab build
```
```bash
pip3 install --upgrade "elyra<2.0.0" && jupyter lab build
```

* [JupyterLab](https://github.com/jupyterlab/jupyterlab) 1.x is supported on **Elyra 0.10.x and below**
- Install from conda-forge

Install from PyPI:
```bash
pip3 install elyra==0.10.3 && jupyter lab build
```
```bash
conda install -c conda-forge "elyra<2.0.0" && jupyter lab build
```
</details>

### Verify Installation

Expand Down