sailfish.setup_base.Parameter

class sailfish.setup_base.Parameter(default: Any, about: str, mutable: bool = False)[source]

Bases: NamedTuple

A model parameter: enables runtime configuring of a setup.

Parameter instances are assigned as class variables to Setup sub-classes. The mutable flag should be set to to True if the parameter is logically adjustable either during the run, or can be superseded when a run is restarted.

__init__()

Methods

`__init__`()
`count`(value, /)	Return number of occurrences of value.
`index`(value[, start, stop])	Return first index of value.

Attributes

`about`	Alias for field number 1
`default`	Alias for field number 0
`mutable`	Alias for field number 2

about: str: Alias for field number 1

count(value, /): Return number of occurrences of value.

default: Any: Alias for field number 0

index(value, start=0, stop=9223372036854775807, /)

Return first index of value.

Raises ValueError if the value is not present.

mutable: bool: Alias for field number 2