Models

subsurfaceio.function_sequences.models

Classes:

Name	Description
CalculationResults	FunctionSequence calculation results
FunctionSequence

CalculationResults

Bases: dict

FunctionSequence calculation results

Methods:

Name	Description
as_labels
to_ndim_collection

as_labels

as_labels()

to_ndim_collection

to_ndim_collection(zero_dim_as_scalar=True)

FunctionSequence

Methods:

Name	Description
calculate	Executes the calculation.

Attributes:

Name	Type	Description
functions	list[Callable]
references	Optional[list[str]]

functions instance-attribute

functions: list[Callable] = functions

references instance-attribute

references: Optional[list[str]] = references

calculate

calculate(
    inputs: dict[str, Any],
    *,
    preprocess_inputs: bool = True,
    combine_inputs_results: bool | list[str] = False,
    use_inputs_over_functions: bool = True,
    return_tolist: bool = False,
    warn_on_exception: bool = False
)

Executes the calculation.