pystclient.models

Data models for STC API interactions.

Functions

position_transformer(v, *args, **kwargs)

Transform position from mapping or tuple.

Classes

BaseProject(*[, name, description])

Base project configuration.

FmuConnections(*[, nodes, edges])

FMU connections configuration.

FmuModelInformation(*, id, version, filename)

Information about an FMU model.

FmuNode(*, label, fmu, model_type, model_id, ...)

FMU node configuration.

FmuNodeEdge(*[, value_type])

FMU node edge (connection) configuration.

FmuSelect(*[, filename, version, id])

FMU model selection.

FmuVariable(*, name, causality[, ...])

FMU variable definition.

FmuVariableGroup(*, name, tag[, variables, ...])

FMU variable group definition.

FmuVariables(*[, fmu_name, inputs, outputs, ...])

FMU variables collection.

LoggingConfiguration(*[, post_plotting, ...])

Logging configuration for simulations.

MeasurementInstance(*[, description, ...])

Measurement instance information.

MeasurementMetadata(*, start_time, end_time, ...)

Metadata for measurement.

MeasurementQuery(*, variables, time_from, to)

Measurement query configuration.

MeasurementVariables(*, name, type, ...)

Measurement variable definition.

Measurements(*, id, simulation_id, ...[, ...])

Measurement data.

ModelParameters(*, name[, inputs, outputs, ...])

Model parameters configuration.

ModelVariable(*, name[, type])

Model variable definition.

ProjectInformation(*, id, name, created_at, ...)

Information about an STC project.

QueryResult(*, signal, x, y, module, statistics)

Result of a query operation.

QueryVariable(*, name, type, variability, ...)

Query variable configuration.

Simulation(*, id[, batch_id])

Simulation information.

SimulationConfig(*, project_id[, os, ...])

Simulation configuration.

SimulationInfo(*, id, name, simulator, ...)

Information about a simulation run.

SimulationParameters(*[, config_name, ...])

Simulation parameters configuration.

SimulatorStatus(*, id, type, display_name, ...)

Status information for a simulator.

UploadedModelInfo(*, id, name)

Information about an uploaded model.

pystclient.models.position_transformer(v: Mapping[str, float] | tuple[float, float], *args: Any, **kwargs: Any) tuple[float, float]

Transform position from mapping or tuple.