Workbooks are Nominal’s tool for creating and sharing interactive data visualizations and analyses. They can be created directly on the Nominal platform or programmatically using the Nominal Python SDK.

Creating a Workbook from a Template

Prerequisites

The Nominal Python Client can be installed with pip:

$
$ pip install nominal

Version

We use semantic versioning for the Nominal Python Client. To see the client version, run the following from within Python:

1
import nominal
2
3
print(nominal.__version__)

$
$ pip install --upgrade nominal

Connect to Nominal

There are two primary ways of authenticating the Nominal Client. The first is to use a profile stored on disk, and the second is to use a token directly.

$
$ nom config profile add default
>
>
# Alternatively, if `nom` is missing from the path:
>
$ python -m nominal config profile add default

1
from nominal.core import NominalClient
2
3
client = NominalClient.from_profile("default")
4
5
# Get details about the currently logged-in user to validate authentication
6
# Will display an object like: `User(display_name='your_email@your_company.com', ...)`
7
print(client.get_user())

$
nom config migrate
>
>
# Or, if `nom` is missing from your path:
>
python -m nominal config migrate

1
from nominal.core import NominalClient
2
3
# Get an instance of the client using provided credentials
4
client = NominalClient.from_token("<insert api key>")
5
6
# Get details about the currently logged-in user to validate authentication
7
# Will display an object like: `User(display_name='your_email@your_company.com', ...)`
8
print(client.get_user())

Steps to Create a Workbook from a Template

1. Obtain the Template RID:
   • Navigate to the Nominal platform.
   • Go to Workbooks ➔ Templates.
   • Click on the desired template.
   • In the top-left corner next to the template name, click the dropdown arrow ⌄.
   • Select Copy RID to copy the template RID to your clipboard.
2. Obtain the Run RID:
   • Navigate to Runs.
   • Click on the run you want to associate with the workbook.
   • On the right side of the screen, locate the RID under “Metadata”.
3. Create the Workbook Using the SDK:

1
from nominal.core import NominalClient
2
3
client = NominalClient.from_profile("default")
4
5
client.create_workbook_from_template(
6
    template_rid = 'your_template_rid',
7
    run_rid = 'your_run_rid',
8
    title = 'My new workbook',
9
    description = 'This is a new workbook created from a template',
10
)

Accessing Your New Workbook

After creating the workbook programmatically:

• Navigate back to Workbooks on the Nominal platform.
• Locate your new workbook titled “My New Workbook”.
• Open it to view and interact with your data visualizations.