adgtk.common.structure

Structure is focused on core objects for defining an internal object. The two main areas are factory and tool usage. Blueprints and components are used by the Factory to create components while the tool specific ones are used for tool definition and creation.

Common structure. This module is used to define the common structures that are used throughout the package.

class adgtk.common.structure.ResultsFile(*, filename: str, purpose: str)

Bases: BaseModel

filename: str

model_config: ClassVar[ConfigDict] = {}

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

purpose: str

class adgtk.common.structure.Scenario(*args, **kwargs)

Bases: Protocol

The Scenario is the root of any experiment

__init__(*args, **kwargs)

start_scenario() → ScenarioResult

class adgtk.common.structure.ScenarioResult(*, files_written: list[ResultsFile])

Bases: BaseModel

files_written: list[ResultsFile]

model_config: ClassVar[ConfigDict] = {}

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