tdms

upload_tdms

upload_tdms(
    client: NominalClient,
    file: Path | str,
    name: str | None = None,
    description: str | None = None,
    timestamp_column: str | None = None,
    timestamp_type: _AnyTimestampType | None = None,
    *,
    wait_until_complete: bool = True
) -> Dataset

Create a dataset in the Nominal platform from a tdms file.

If name is None, the dataset is created with the name of the file with a .csv suffix.

If 'timestamp_column' is provided, it must be present in every group and the length of all data columns must be equal to (and aligned with) with 'timestamp_column'.

If 'timestamp_column' is None, TDMS channel properties must have both a wf_increment and wf_start_time property to be included in the dataset.

Note that both 'timestamp_column' and 'timestamp_type' must be included together, or excluded together.

Channels will be named as f"{group_name}.{channel_name}" with spaces replaced with underscores.

If wait_until_complete=True (the default), this function waits until the dataset has completed ingestion before returning. If you are uploading many datasets, set wait_until_complete=False instead and call wait_until_ingestions_complete() after uploading all datasets to allow for parallel ingestion.