pyfebiopt.optimize.options

Configuration dataclasses for the optimization engine.

Classes

`GridPolicyOptions`	Configuration for how simulations align with experiments.
`JacobianOptions`	Jacobian evaluation controls.
`CleanupOptions`	Cleanup behavior for working directories.
`RunnerOptions`	Execution backend configuration.
`StorageOptions`	Storage and logging configuration.
`LoggingOptions`	Console reporting controls.
`MonitorOptions`	Monitoring client configuration.
`OptimizerOptions`	Optimizer adapter selection and advanced settings.
`EngineOptions`	Aggregate container for optimization engine configuration.

Module Contents

class pyfebiopt.optimize.options.GridPolicyOptions

Configuration for how simulations align with experiments.

policy: Literal['exp_to_sim', 'fixed_user'] = 'exp_to_sim'

values: collections.abc.Sequence[float] | None = None

class pyfebiopt.optimize.options.JacobianOptions

Jacobian evaluation controls.

enabled: bool = False

perturbation: float = 1e-06

parallel: bool = True

class pyfebiopt.optimize.options.CleanupOptions

Cleanup behavior for working directories.

remove_previous: bool = False

mode: Literal['none', 'all'] = 'none'

class pyfebiopt.optimize.options.RunnerOptions

Execution backend configuration.

jobs: int = 1

command: collections.abc.Sequence[str] | None = None

env: collections.abc.Mapping[str, str] | None = None

class pyfebiopt.optimize.options.StorageOptions

Storage and logging configuration.

mode: Literal['disk', 'tmp'] = 'disk'

root: str | pathlib.Path | None = None

log_file: str | pathlib.Path | None = None

class pyfebiopt.optimize.options.LoggingOptions

Console reporting controls.

optimizer_space: bool = False

class pyfebiopt.optimize.options.MonitorOptions

Monitoring client configuration.

enabled: bool = True

socket: str | pathlib.Path | None = None

label: str | None = None

class pyfebiopt.optimize.options.OptimizerOptions

Optimizer adapter selection and advanced settings.

name: Literal['least_squares', 'minimize'] = 'least_squares'

settings: collections.abc.Mapping[str, Any]

reparametrize: bool = True

class pyfebiopt.optimize.options.EngineOptions

Aggregate container for optimization engine configuration.

jacobian: JacobianOptions

cleanup: CleanupOptions

runner: RunnerOptions

storage: StorageOptions

logging: LoggingOptions

monitor: MonitorOptions

optimizer: OptimizerOptions