nbodykit.hod

Functions

HODModelFactory(name, func_name)

Factory to generate the functions that will return one of the pre-built Halotools HOD models.

Classes

HODModel

A class providing an interface beteween HOD models in nbodykit and halotools.

Hearin15Model

alias of nbodykit.hod.hearin15

Leauthaud11Model

alias of nbodykit.hod.leauthaud11

Zheng07Model

Methods

class nbodykit.hod.Zheng07Model[source]

Methods

to_halotools(cosmo, redshift, mdef[, …])

Return the Zheng 07 HOD model.

static to_halotools(cosmo, redshift, mdef, concentration_key=None, **kwargs)[source]

Return the Zheng 07 HOD model.

See halotools.empirical_models.zheng07_model_dictionary().

Parameters
  • cosmo – the nbodykit or astropy Cosmology object to use in the model

  • redshift (float) – the desired redshift of the model

  • mdef (str, optional) – string specifying mass definition, used for computing default halo radii and concentration; should be ‘vir’ or ‘XXXc’ or ‘XXXm’ where ‘XXX’ is an int specifying the overdensity

  • concentration_key (str) – the name of the column that will specify concentration; if not provided, the analytic formula from Dutton and Maccio 2014 is used.

  • **kwargs – additional keywords passed to the model components; see the Halotools documentation for further details

Returns

the halotools object implementing the HOD model

Return type

HodModelFactory

nbodykit.hod.Leauthaud11Model

alias of nbodykit.hod.leauthaud11

nbodykit.hod.Hearin15Model

alias of nbodykit.hod.hearin15