Examples

Connecting to Nominal

Retrieve your API key from /sandbox on your Nominal tenant. Then, set the Nominal connection parameters in a terminal:

python3 -m nominal auth set-token

This sets the auth token on your system, which can be updated with the same command as needed.

Upload a Dataset

dataset = nm.upload_csv(
    '../path/to/data.csv',
    name='Stand A',
    timestamp_column='timestamp',
    timestamp_type='epoch_seconds',
)
print('Uploaded dataset:', dataset.rid)

Create a Run

run = nm.create_run(
    name='Run A',
    start='2024-09-09T12:35:00Z',
    end='2024-09-09T13:18:00Z',
)
print("Created run:", run.rid)

Update metadata of an existing Run

run = nm.get_run('ri.scout.gov-staging.run.ce205f7e-9ef1-4a8b-92ae-11edc77441c6')
run.update(name='New Run Title')

Change default Nominal tenant

By default, the library uses https://api.gov.nominal.io/api as the base url to the Nominal platform. Your scripts can change the URL they use with set_base_url(). For example, to use the staging URL:

nm.set_base_url('https://api-staging.gov.nominal.io/api')