Workbooks

A workbook is a set of charts and panels for viewing a run’s or an asset’s data in Nominal. A workbook template defines the panels once, so you can create the same workbook for every test.

Connect the client

This guide assumes you have installed the client and setup your API keys.

from nominal.core import NominalClient

client = NominalClient.from_profile("default")

Create a workbook from a template

create_workbook() creates a workbook for a run or an asset. The template’s inputs must match the run’s ref names or the asset’s data scope names.

template = client.get_workbook_template("<TEMPLATE_RID>")
workbook = template.create_workbook(run=client.get_run("<RUN_RID>"), title="Flight review")
print(workbook.nominal_url)

To copy a template’s RID, open it from Workbooks → Templates, click the arrow next to its name and select Copy RID. To look templates up by name or label instead, use search_workbook_templates().

Find workbooks

search_workbooks() filters by run, asset, labels and author:

for workbook in client.search_workbooks(run=run):
    print(workbook.title, workbook.nominal_url)

search_workbooks() and search_workbooks() search the workbooks of one run or asset.