py21cmfast.wrapper.perturb_halo_list(*, redshift, init_boxes=None, halo_field=None, user_params=None, cosmo_params=None, astro_params=None, flag_options=None, random_seed=None, regenerate=None, write=None, direc=None, hooks=None, **global_kwargs)[source]

Given a halo list, perturb the halos for a given redshift.

  • redshift (float) – The redshift at which to determine the halo list.

  • init_boxes (InitialConditions, optional) – If given, these initial conditions boxes will be used, otherwise initial conditions will be generated. If given, the user and cosmo params will be set from this object.

  • user_params (UserParams, optional) – Defines the overall options and parameters of the run.

  • cosmo_params (CosmoParams, optional) – Defines the cosmological parameters used to compute initial conditions.

  • astro_params (AstroParams instance, optional) – The astrophysical parameters defining the course of reionization.

  • **global_kwargs – Any attributes for GlobalParams. This will temporarily set global attributes for the duration of the function. Note that arguments will be treated as case-insensitive.



Other Parameters:

regenerate, write, direc, random_seed – See docs of initial_conditions() for more information.


Fill this in once finalised