schema

schema module-attribute

schema = SchemaCLI()

SchemaCLI

Micromechanical model JSON Schema command line interface.

generate classmethod

generate(
    type: Literal["config", "labels", "calibrations", "plots"],
    output: str | PathLike,
    **kwargs
)

Generate the JSON Schema of the micromechanical configuration.

PARAMETER	DESCRIPTION
type	Type of JSON schema to generate. TYPE: Literal['config', 'labels', 'calibrations', 'plots']
output	Path to the output file. TYPE: str | PathLike
kwargs	Additional keyword arguments passed to the pydantic model_json_schema method. DEFAULT: {}