Function-usage examples by category

Here we present docstrings of the most commonly used functions and classes grouped together by functionality. Many docstrings contain example code to demonstrate basic usage. For documentation of functions not listed here, see Comprehensive Halotools Reference/API.

Modeling the Galaxy-Halo Connection

Composite models

HOD models

• Zheng et al. (2007) Composite Model
• Leauthaud et al. (2011) Composite Model
• Tinker et al. (2013) Composite Model
• Hearin et al. (2015) Composite Model
• Zu & Mandelbaum et al. (2015) Composite Model
• Zu & Mandelbaum et al. (2016) Composite Model

CLF models

• Cacciato et al. (2009) Composite Model

Subhalo-based models

• Behroozi et al. (2010) Composite Model
• Abundance Matching and Age Matching

Component models

• Phase Space Component Models
  • Halo Mass Definitions
  • NFW Profile Models
  • Subhalo-based Profiles
  • Central Galaxy Profile Models
  • Monte Carlo Realizations of Galaxy Profiles
• HOD Occupation Component Models
  • Zheng et al. (2007)
  • Leauthaud et al. (2011)
  • Tinker et al. (2013)
• Model Factories
  • HOD Model Factories
  • Subhalo Model Factories

Making Mock Observations

• Two-Point Correlation Functions
• Calculating the HOD
• Galaxy Group Statistics
• Isolation Criteria
• Pairwise Velocities
• Radial Profiles
• Void Statistics
• Large Scale Density
• Tensor Calculations

Processing Simulation Data

• Using and Generating Halotools-Formatted Catalogs
• Reading and Reducing Halo ASCII Data

Utility Functions

• Cross-matching catalogs with a common object ID
• Calculating quantities for objects grouped into a common halo
• Generating Monte Carlo realizations
• Matching one distribution to another
• Probabilistic binning
• Estimating two-dimensional PDFs