calibration

calibration module-attribute

calibration: CalibrationCLI = CalibrationCLI()

CLIOptions

Bases: HashableBaseModelIO

exclude_calibrations class-attribute instance-attribute

exclude_calibrations: List[str] = []

Calibrations to be excluded

exclude_models class-attribute instance-attribute

exclude_models: List[str] = []

Models to be excluded

include_calibrations class-attribute instance-attribute

include_calibrations: List[str] | Literal['all'] | None = 'all'

Calibrations to be included

include_models class-attribute instance-attribute

include_models: List[str] | Literal['all'] | None = 'all'

Models to be included

overwrite class-attribute instance-attribute

overwrite: bool = False

Whether to overwrite calibrations

overwrite_figures class-attribute instance-attribute

overwrite_figures: bool = False

Whether to overwrite figures

skip class-attribute instance-attribute

skip: bool = False

Whether to skip calibrations

model_post_init

model_post_init(__context: Any)

CalibrationCLI

Bases: _CLIBase

Micromechanical model calibration command line interface.

Config classmethod

Config() -> Type[CalibrationConfig]

key classmethod

key() -> str

loadConfig classmethod

loadConfig(
    config: str | PathLike | None = None,
    base_config: str | PathLike | None = None,
    key: str = "",
) -> CalibrationConfig

run

run(
    config: str | PathLike | None = None,
    base_config: str | PathLike | None = None,
    key: str = "",
    *,
    overwrite: bool | None = None,
    skip: bool | None = None,
    overwrite_figures: bool | None = None,
    include_calibrations: List[str] | str | None = None,
    exclude_calibrations: List[str] | str | None = None,
    include_models: List[str] | str | None = None,
    exclude_models: List[str] | str | None = None,
    continue_last_unfinished_run: bool = False,
    continue_last_unfinished_run_outcmaes: str | None = None,
    continue_last_run: bool = False,
    logfile: str | None = None,
    maxiter: int | None = None,
    maxfun: int | None = None,
    return_initial_fitness: bool = False,
    **kwargs
) -> Dict[str, float] | None

Calibrate the micromechanical model.

PARAMETER	DESCRIPTION
config	Configuration file, by default None. If None, search for the default configuration files. TYPE: str | PathLike | None DEFAULT: None
base_config	Base configuration file to merge with the main configuration file, by default None TYPE: str | PathLike | None DEFAULT: None
key	Key of the table in the configuration file, by default "" TYPE: str DEFAULT: ''
overwrite	Overwrite existing calibration, by default False TYPE: bool DEFAULT: None
skip	Skip calibration, by default False TYPE: bool DEFAULT: None
overwrite_figures	Overwrite existing figures, by default False TYPE: bool DEFAULT: None
include_calibrations	Include calibrations, by default None (all). Can be glob patterns. TYPE: List[str] | str DEFAULT: None
exclude_calibrations	Exclude calibrations, by default None. Can be glob patterns. TYPE: List[str] | str DEFAULT: None
include_models	Include models, by default None (all). Can be glob patterns. TYPE: List[str] | str DEFAULT: None
exclude_models	Exclude models, by default None. Can be glob patterns. TYPE: List[str] | str DEFAULT: None
continue_last_unfinished_run	Continue the last unfinished calibration, by default False TYPE: bool DEFAULT: False
continue_last_unfinished_run_outcmaes	Override the path to the outcmaes folder to continue the last unfinished calibration, by default None TYPE: str DEFAULT: None
continue_last_run	Continue the last calibration, by default False TYPE: bool DEFAULT: False
logfile	Print the output to a log file, by default None TYPE: str DEFAULT: None
maxiter	Overriding the maximum number of iterations, by default None TYPE: int DEFAULT: None
maxfun	Overriding the maximum number of function evaluations, by default None TYPE: int DEFAULT: None
return_initial_fitness	Return initial fitness for debugging, by default False TYPE: bool DEFAULT: False
kwargs	Additional keyword arguments to pass to the calibrate method. TYPE: Any DEFAULT: {}

section classmethod

section() -> str

CalibrationConfig

Bases: HashableBaseModelIO

Micromechanical model calibration configuration.

calculation class-attribute instance-attribute

calculation: Annotated[CalculationOptions, Field(exclude=True)] = (
    CalculationOptions()
)

Base calculation options

calibration class-attribute instance-attribute

calibration: Annotated[CalibrationOptions, Field(exclude=True)] = (
    CalibrationOptions()
)

Base calibration options

cli class-attribute instance-attribute

cli: CLIOptions = CLIOptions()

Command line options

experiment_calibrations class-attribute instance-attribute

experiment_calibrations: Dict[str, ExperimentCalibrationOptions] = {}

Experiment calibrations

figures class-attribute instance-attribute

figures: Annotated[Dict[str, FigureOptions], Field(exclude=True)] = {}

Base figures

root class-attribute instance-attribute

root: str | None = None

Root path

model_post_init

model_post_init(__context: Any)

Post-initialization.

ExperimentCalibrationOptions

Bases: ExpandableBaseModelIO

Micromechanical model experiment calibration configuration.

calculation class-attribute instance-attribute

calculation: CalculationOptions = CalculationOptions()

Calculation options

calibration class-attribute instance-attribute

calibration: CalibrationOptions = CalibrationOptions()

Calibration options

experiment class-attribute instance-attribute

experiment: ExperimentOptions = ExperimentOptions()

Experiment files and filters

figures class-attribute instance-attribute

figures: Dict[str, FigureOptions] = {}

Figures

model_type class-attribute instance-attribute

model_type: str = 'CH-OSIMSAND'

Type of the model

name class-attribute instance-attribute

name: str | None = None

Name of the calibration, by default None which will be generated from the base name and matrix options

model_post_init

model_post_init(__context: Any)

Post-initialization.