SimulationConfig

class pystclient.models.SimulationConfig(*, project_id: Annotated[str | UUID, PlainSerializer(func=str, return_type=str, when_used=always)], os: str = 'linux', display_name: str = 'STCSimulation', type: SimulationType = SimulationType.DISTRIBUTED, project_version_id: Annotated[str | UUID, PlainSerializer(func=str, return_type=str, when_used=always)] | None = None, simulation_name: str | None = None, parameter_set_names: list[str] = None, batch_size: int = 1, is_interactive: bool = False)

Bases: BaseModel

Simulation configuration.

__init__(**data: Any) → None

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Methods

__init__(**data)	Create a new model by parsing and validating input data from keyword arguments.
construct([_fields_set])
copy(*[, include, exclude, update, deep])	Returns a copy of the model.
dict(*[, include, exclude, by_alias, ...])
from_orm(obj)
json(*[, include, exclude, by_alias, ...])
model_construct([_fields_set])	Creates a new instance of the Model class with validated data.
model_copy(*[, update, deep])	!!! abstract "Usage Documentation"
model_dump(*[, mode, include, exclude, ...])	!!! abstract "Usage Documentation"
model_dump_json(*[, indent, ensure_ascii, ...])	!!! abstract "Usage Documentation"
model_json_schema([by_alias, ref_template, ...])	Generates a JSON schema for a model class.
model_parametrized_name(params)	Compute the class name for parametrizations of generic classes.
model_post_init(context, /)	Override this method to perform additional initialization after __init__ and model_construct.
model_rebuild(*[, force, raise_errors, ...])	Try to rebuild the pydantic-core schema for the model.
model_validate(obj, *[, strict, extra, ...])	Validate a pydantic model instance.
model_validate_json(json_data, *[, strict, ...])	!!! abstract "Usage Documentation"
model_validate_strings(obj, *[, strict, ...])	Validate the given object with string data against the Pydantic model.
parse_file(path, *[, content_type, ...])
parse_obj(obj)
parse_raw(b, *[, content_type, encoding, ...])
schema([by_alias, ref_template])
schema_json(*[, by_alias, ref_template])
serialize_batch_size(batch_size)	Serialize batch size to string.
serialize_project_id(project_id)	Serialize project ID to uppercase string.
update_forward_refs(**localns)
validate(value)
validate_batch_size()	Validate batch size is within acceptable range.
validate_interactive()	Non-interactive mode is only supported for distributed simulations.

Attributes

model_computed_fields
model_config	Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
model_extra	Get extra fields set during validation.
model_fields
model_fields_set	Returns the set of fields that have been explicitly set on this model instance.
project_id
os
display_name
type
project_version_id
simulation_name
parameter_set_names
batch_size
is_interactive

serialize_batch_size(batch_size: int) → str

Serialize batch size to string.

serialize_project_id(project_id: Annotated[str | UUID, PlainSerializer(func=str, return_type=str, when_used=always)]) → str

Serialize project ID to uppercase string.

validate_batch_size() → Self

Validate batch size is within acceptable range.

validate_interactive() → Self

Non-interactive mode is only supported for distributed simulations.

batch_size: Annotated[int, FieldInfo(annotation=NoneType, required=False, default=None, alias_priority=2, serialization_alias='batch-size')]

display_name: str

is_interactive: Annotated[bool, FieldInfo(annotation=NoneType, required=True, alias_priority=2, serialization_alias='interactive?')]

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

os: str

parameter_set_names: Annotated[list[str], FieldInfo(annotation=NoneType, required=False, default=None, alias_priority=2, serialization_alias='parameter-set-names')]

project_id: Annotated[str | UUID, PlainSerializer(func=str, return_type=str, when_used=always)]

project_version_id: Annotated[Annotated[str | UUID, PlainSerializer(func=str, return_type=str, when_used=always)] | None, FieldInfo(annotation=NoneType, required=True, alias_priority=2, serialization_alias='project-version-id')]

simulation_name: Annotated[str | None, FieldInfo(annotation=NoneType, required=False, default=None, alias_priority=2, serialization_alias='simulation-name')]

type: SimulationType