JupyterLab

Bench workspaces require setting a Docker image to use as the image for the workspace. Platform Core provides a default Docker image with JupyterLab installed.

JupyterLab supports Jupyter Notebook documents (.ipynb). Notebook documents consist of a sequence of cells which may contain executable code, markdown, headers, and raw text.

The JupyterLab Docker image contains the following environment variables:

Variable	Set to
ICA_URL	https://ica.illumina.com/ica (Platform Core server URL)
ICA_PROJECT_UUID	Current project UUID
ICA_SNOWFLAKE_ACCOUNT	Platform Core Snowflake (Base) Account ID
ICA_SNOWFLAKE_DATABASE	Platform Core Snowflake (Base) Database ID
ICA_PROJECT_TENANT_NAME	Name of the owning tenant of the project where the workspace is created.
ICA_STARTING_USER_TENANT_NAME	Name of the tenant of the user which last started the workspace.
ICA_COHORTS_URL	URL of the Cohorts web application used to support the Cohort's view

To export data from your workspace to your local machine, it is best practice to move the data in your workspace to the /data/project/ folder so that it becomes available in your project under projects > your_project > Data.

Platform Core Python Library

Included in the default JupyterLab Docker image is a python library with APIs to perform actions in Platform Core, such as add data, launch pipelines, and operate on Base tables. The python library is generated from the Open API specification using openapi-generator.

The Platform Core Python library API documentation can be found in folder /etc/ica/data/ica_v2_api_docs within the JupyterLab Docker image.

See the Bench ICA Python Library Tutorial for examples on using the Platform Core Python library.