py21cmfast.cli.NodeRedshiftParameters

class py21cmfast.cli.NodeRedshiftParameters

Parameters for setting the node redshifts of the simulation.

update_inputs(inputs: py21cmfast.wrapper.inputs.InputParameters, force: bool = False) → py21cmfast.wrapper.inputs.InputParameters

Return a copy of the input parameters with updated node redshifts.

Parameters:
Return type:

py21cmfast.wrapper.inputs.InputParameters

max: float | None = None

The maximum node redshift. If not provided, the Z_HEAT_MAX parameter of the input parameters is used.

min: float | None = None

The minimum node redshift. If not provided, and redshift evolution is required by the input parameters, the default minimum redshift of 5.5 is used.

n: int | None = None

The number of node redshifts. If provided, this overrides step and sets the step size such that n redshifts are included between min and max.

spacing: Literal['logspace', 'linear'] = 'logspace'

The function to use for spacing the node redshifts.

step: float | None = None

The step size (or step factor for logspace) of the node redshifts. If not provided, the default step size of 0.1 for linear spacing or ZPRIME_STEP_FACTOR if logspace is used.