avl_config

avl_config#

YAML project-file schema and loader. Defines the Pydantic models that parse and validate .yml project files, and load_config() which reads a file and exits with a structured error message on bad input.

YAML project-file schema and loader.

class avl_aero_tables.avl_config.InputSpec(*, geometry)[source]#

Bases: BaseModel

Parameters:

geometry (str)

geometry: str#
model_config = {}#

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

class avl_aero_tables.avl_config.OutputSpec(*, format='csv')[source]#

Bases: BaseModel

Parameters:

format (Literal['csv', 'json', 'df'])

format: Literal['csv', 'json', 'df']#
model_config = {}#

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

class avl_aero_tables.avl_config.ProjectConfig(*, input, sweep, output=OutputSpec(format='csv'))[source]#

Bases: BaseModel

Parameters:
input: InputSpec#
model_config = {}#

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

output: OutputSpec#
sweep: SweepSpec#
class avl_aero_tables.avl_config.SweepSpec(*, alpha, beta, ctrl_sweeps={})[source]#

Bases: BaseModel

Parameters:

  • alpha (list[float])

  • beta (list[float])

  • ctrl_sweeps (dict[str, list[float]])

alpha: list[float]#
beta: list[float]#
ctrl_sweeps: dict[str, list[float]]#
classmethod ctrl_sweeps_non_empty_lists(v)[source]#
Parameters:

v (dict[str, list[float]])

Return type:

dict[str, list[float]]

model_config = {}#

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

classmethod non_empty(v)[source]#
Parameters:

v (list[float])

Return type:

list[float]

avl_aero_tables.avl_config.load_config(yml_path)[source]#
Parameters:

yml_path (Path)

Return type:

ProjectConfig