Installation

We recommend installing our Python library and JupyterLab extension with Conda.

However, if you prefer pip/Pipenv and npm, we also publish the library as a Python wheel and the extension as an npm tarball.

Install Conda package

Setup Conda environment

Make sure to use Conda 64-bit since recent versions of some packages like openjdk are missing in Conda 32-bit.

Add conda-forge to your Conda channels if you haven’t already done it:

conda config --add channels conda-forge

Create a new Conda environment and activate it:

conda create --name activeviam
conda activate activeviam

Using Artifactory

To add ActiveViam’s Artifactory repository as a Conda channel, follow these steps:

First, open this page and fill the authentication form with your ActiveViam credentials to get your encrypted password.

Build the Conda channel URL with your ActiveViam username and encrypted password: https://{{username}}:{{encrypted_password}}@activeviam.jfrog.io/activeviam/api/conda/conda-internal.

Add this channel to your Conda channels using conda config –add channels {{channel_url}}. For instance, if your username was pierre and your encrypted password was H3rm3, you would run this command:

conda config --add channels https://pierre:H3rm3@activeviam.jfrog.io/activeviam/api/conda/conda-internal

We provide a single-package bundle that will install our Python library, our JupyterLab extension and all their dependencies. It’s the easiest way to get started:

conda install activeviam-ce-bundle

Note: JupyterLab needs to be rebuilt to include the ActiveViam extension. You can either wait until you open your first JupyterLab session and click on the Build button when prompted, or pro-actively run the following command (it can take several minutes):

jupyter lab build

Without Artifactory

This method is less convenient than the one relying on Artifactory. The set up is a bit more convoluted and upgrades will not be streamlined. Thus, we recommend to only pick this method if your network policy is blocking our Artifacory repository.

You will need to have artifacts for our Conda packages on your computer. Let’s say you have our bundle at /home/me/project/activeviam-ce-bundle-0.2.0-0.tar.bz2. Then, to install it, run these commands:

# Create a local Conda channel first.
conda install conda-build
mkdir -p /home/me/project/tmp/channel/noarch
mv /home/me/project/activeviam-ce-bundle-0.2.0-0.tar.bz2 /home/me/project/tmp/channel/noarch
conda index /home/me/project/tmp/channel/
# Do the actual installation.
conda install --channel file://home/me/project/tmp/channel activeviam-ce-bundle
# Rebuild JupyterLab to include the ActiveViam extension. This can take several minutes.
jupyter lab build

Separate Packages

If you are comfortable with Conda and would like a more fine-grained control on the packages being installed in your environments, you can install these packages instead:

conda install activeviam-ce jupyterlab-activeviam jupyterlab=1.2 openjdk=11 python=3.7

Like with the bundle package, we recommend pro-actively rebuilding JupyterLab to include the ActiveViam extension (it can take several minutes):

jupyter lab build

Enterprise Edition

The Enterprise Edition requires you to have a license.

To install it, follow the previous guide replacing -ce- by -ee-. For instance:

conda install activeviam-ee-bundle