piglot.solver.multi_case_solver.Case

class Case

Bases: ABC

Base case class for multi-case solvers.

Methods

get_fields	Get the fields to output for this case.
name	Return the name of the case.
read	Read the case from the configuration dictionary.
run	Run the case for the given set of parameters.

abstract get_fields() → List[str]

Get the fields to output for this case.

Returns

List[str]

Fields to output for this case.

abstract name() → str

Return the name of the case.

Returns

str

Name of the case.

abstract classmethod read(name: str, config: Dict[str, Any]) → T

Read the case from the configuration dictionary.

Parameters

namestr

Name of the case.

configDict[str, Any]

Configuration dictionary.

Returns

Case

Case to use for this problem.

abstract run(parameters: ParameterSet, values: ndarray, tmp_dir: str) → CaseResult

Run the case for the given set of parameters.

Parameters

parametersParameterSet

Parameter set for this problem.

valuesnp.ndarray

Current parameters to evaluate.

tmp_dirstr

Temporary directory to run the problem.

Returns

CaseResult

Result of the case.