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 and User Configuration

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

Follow the steps below to enable Jupyter: 

1. Select Admin from the top menu. 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.

   

4. After activating the account, you will be able to allow all users access to the feature. You may also restrict access to authorized users and configure CPU/Memory Limits for specific users.

   

Getting Started

1. After enabling Jupyter, the feature can be accessed by navigating to Data in the top menu bar.
2. Select the menu on the lefthand side and choose Jupyter Workspaces.
3. Create a new workspace by clicking + New Workspace in the top right corner or the page.

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 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

Scheduling a Jupyter notebook by clicking 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. Click Save.Once saved, you will see the data flow in the DataFlow page. You can navigate back to the Jupyter Workspace by clicking 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
2. Select Features
3. Select Jupyter and click the Usage tab. Here you can see the total hours used across workspaces.

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

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 kernal? 

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

Can I reset the kernal?

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