astropy:docs

HodModelDesigner

class halotools.hod_designer.HodModelDesigner(*args, **kwargs)[source] [edit on github]

Bases: object

This class is used to create a blueprint to give to halotools.hod_factory; the HOD factory will use the blueprint to instantiate a composite HOD model; all of the behavior of the composite model derives from a set of component models.

The blueprint created by HodModelDesigner is in the form of a dictionary. The keys of this dictionary give the name of the gal_type population, the values of the dictionary are themselves dictionaries giving a correspondence between the type of behavior, e.g., ‘occupation_model’ or ‘quiescence_model’, and the class instance used to govern that behavior.

For clarity, consider a specific, simple example. The blueprint dictionary is {‘centrals’:central_dict}. So the blueprint has only one key, ‘centrals’, meaning that the composite model created with this universe that will

This class provides a range of options for how to draw up a composite model blueprint.

Option 1: keyword arguments are interpreted as the string specifying the gal_type, and the values attached to each keyword are either component model instances and/or strings specifying class names of component models.

a set of HOD model components as input, and composes their behavior in the appropriate fashion for the HOD factory to understand. In particular, the prime function of this class is to bundle a set of input component models into a component_model_dict, which is a dictionary containing a set of instructions to pass to the HOD factory.

Page Contents