--- myst: html_meta: description: "Guides, examples and reference for the Nominal Python Client." --- # Nominal Python Client {.lead} An Open-source Python library for working with the [Nominal](https://nominal.io) platform. It allows you to automate data upload, streaming, and retrieval. ## Intro Once you [install](/guides/install.md) the library and set-up your [API keys](/guides/api-keys-setup.md), you can easily upload data to Nominal. ```python from nominal.core import NominalClient client = NominalClient.from_profile("default") asset = client.get_or_create_asset_by_properties({"serial": "SN42"}, name="Test stand SN42") dataset = asset.get_or_create_dataset("primary") file = dataset.add_tabular_data("run.csv", timestamp_column="time", timestamp_type="iso_8601") # your CSV file.poll_until_ingestion_completed() # raises NominalIngestError if the ingest fails print(asset.nominal_url) ``` ## Let's go ::::{grid} 1 1 2 2 :gutter: 2 :::{grid-item-card} {octicon}`key` API keys setup :link: guides/api-keys-setup :link-type: doc Create an API key and save it as a profile. ::: :::{grid-item-card} {octicon}`rocket` Quickstart :link: guides/quickstart :link-type: doc Upload a file, stream data, mark a run and read it back. ::: :::{grid-item-card} {octicon}`code` Examples :link: examples/index :link-type: doc Full, runnable scripts. ::: :::{grid-item-card} {octicon}`book` Reference :link: ref/index :link-type: doc Every class, function and `nom` command. ::: :::: ```{toctree} :hidden: :caption: Get started Overview Install API keys setup Quickstart ``` ```{toctree} :hidden: :caption: Tutorials Upload and stream tutorial Data integration tutorial ``` ```{toctree} :hidden: :caption: CLI Overview Download data Instrumentation sheets ``` ```{toctree} :hidden: :caption: Datasets Overview CSV Journal JSON HDF5 PX4 Export data Decimate data Channels and data types Avro streams ``` ```{toctree} :hidden: :caption: Concepts Runs Assets Asset types Workbooks Events ``` ```{toctree} :hidden: :caption: Stream Overview Logs Trigger alerts ``` ```{toctree} :hidden: :caption: Auto-flag events Authoring checklists as code Data review ``` ```{toctree} :hidden: :caption: Video Video ingest MCAP video ingest Live video streaming Chart animations Object identification ``` ```{toctree} :hidden: :caption: Drives Overview ``` ```{toctree} :hidden: :caption: Ingest guides Ingest jobs File extractors ``` ```{toctree} :hidden: :caption: Examples :glob: Gallery examples/* ``` ```{toctree} :hidden: :caption: Reference :maxdepth: 2 Overview Core Timestamps Exceptions ``` ```{toctree} :hidden: :caption: Command Line :maxdepth: 1 nom CLI ``` ```{toctree} :hidden: :caption: Experiments :maxdepth: 1 ref/experimental/compute ref/experimental/compute-as-code ref/experimental/derived_datasets ref/experimental/extractors ref/experimental/drives ref/experimental/ingest ref/experimental/migration ref/experimental/spatial ref/experimental/video ref/experimental/video_processing ``` ```{toctree} :hidden: :caption: Third-Party Integrations :maxdepth: 1 ref/ibis/index ref/thirdparty/matlab ref/thirdparty/pandas ref/thirdparty/polars ref/thirdparty/tdms ``` ```{toctree} :hidden: :caption: Releases ref/changelog ``` ```{toctree} :hidden: :caption: Project contributing license ```