Jupyter Workspaces

Intro

Jupyter Workspaces in Domo is a web-based interactive development environment for Jupyter notebooks, code, and data. Workspaces are tightly integrated with Domo to allow users to easily explore their Domo DataSets, leverage instantaneous code execution to develop pipelines for data science and machine learning, document their processes, create custom visualizations, and write transformed data back into Domo.

Jupyter Workspaces use the JupyterLab interface. For more information on JupyterLab, see https://jupyterlab.readthedocs.io/en/latest/

Jupyter Enablement

In order to start using Jupyter, the feature must be configured.

Follow the steps below to enable Jupyter: 

1. Select Admin from the navigation header. For smaller screen sizes, you may need to expand the More tab. 

2. Navigate to Features and select Jupyter from the options. 

3. Activate the feature by adjusting the toggle next to Jupyter Account Inactive.

Your account has been activated.

After activating the account, you can allow all or specific users access to Jupyter.

4. Select a Compute Tier Limit.

5. Select Save.

Getting Started

1. After enabling Jupyter, access the feature by selecting Data in the navigation header.

2. Select  menu and choose Jupyter Workspaces.

3. Create a new workspace by selecting + New Workspace.

The Create Jupyter Workspace modal displays. 

4. Customize the workspace by adding a Title, Description, Compute Tier Limit, Timeout, Kernel, and Input/Output DataSets. 

Learn more about Workspace Options in the table below: 

Jupyter Basics 

Reading Data

Data can be read into a Jupyter Notebook using the domojupyter library. This library provides useful functionality to interact with Domo within Jupyter. The domo.read_dataframe command can be used to read data from a Domo data source into your Jupyter Notebook for further processing and analysis.

See the example below: 

Writing Data

Data can be written back to a Domo data source using the domojupyter library. This library provides useful functionality to interact with Domo within Jupyter. Use the domo.write_dataframe command command to write results back to the Domo Data sources configured for the Jupyter workspace.

See the example below: 

Installing and Using Libraries

Libraries can be installed in the Jupyter workspace by opening a terminal and executing the appropriate commands. An example command to install the Seaborn library is conda install seaborn -y. Once installed, these libraries can be imported and used within the Jupyter Notebooks.

See the example below:

Scheduling a Notebook

Schedule a Jupyter notebook by selecting the “dataflow” option within the Juptyer Notebook interface.

Once selected, you will be presented with the option to create a Jupyter Dataflow. Enter a Name, Description, and desired scheduling options. Select Save.

Once saved, you will see the data flow in the DataFlow page.

You can navigate back to the Jupyter Workspace by Selecting the Edit in Jupyter option in the details view of the data flow.

Usage Monitoring

You can monitor Jupyter usage within Domo.

1. Navigate to Admin > Features

3. Select Jupyter > Usage.

Here, you can see the total hours used across workspaces.

To see the detailed usage, select a workspace. You will see associated data flows and the server specs being used. 

Experiencing issues? See Jupyter Troubleshooting Guide or contact support@domo.com for assistance. 

FAQs

Can I install Plugins?

Plugins are not currently supported.

Can I share Jupyter Notebooks?

This is on our roadmap to provide this functionality. Ownership of a workspace can be transferred as a way to provide limited sharing capability.

Can I trial the feature?

Please contact your Customer Success Manager or Account Executive for the most up to date information on the trial experience of Jupyter.

Does Domo offer data science services?      

Yes, we have a team of experienced data scientists that are ready to help as needed. Please contact your Account Executive for more information.

How do I change the kernel? 

First, you must stop the workspace. You may then change the kernel in the Domo workspace edit view.

Can I reset the kernel?

Yes. The wrench icon on the workspaces screen has an option to Restore Kernel Defaults. 

I'm experiencing issues integrating third-party libraries.

Domo's Jupyter integration allows users to install third-party libraries. However, Domo will not natively support every third-party library. Some third-party libraries may require more effort on the user's end to install, configure, and troubleshoot.