SkyPy Documentation

This package contains methods for modelling the Universe, galaxies and the Milky Way. Also included are methods for generating observed data.

Getting Started

User Documentation

Packages

Galaxies (skypy.galaxy)

This module contains methods that model the intrinsic properties of galaxy populations.

Luminosities (skypy.galaxy.luminosity)

Models of galaxy luminosities.

Models

herbel_luminosities

Model of Herbel et al (2017)

Ellipticities (skypy.galaxy.ellipticity)

Galaxy ellipticity module.

This module provides facilities to sample the ellipticities of galaxies.

Models

beta_ellipticity

Galaxy ellipticities sampled from a reparameterized beta distribution.

Redshifts (skypy.galaxy.redshift)

Galaxy redshift module.

This module provides facilities to sample galaxy redshifts using a number of models.

Models

herbel_redshift	Redshift following the Schechter luminosity function marginalised over luminosities following the Herbel et al.
herbel_pdf	Calculates the redshift pdf of the Schechter luminosity function according to the model of Herbel et al.
smail	Redshifts following the Smail et al.

Sizes (skypy.galaxy.size)

Galaxy size module.

This modules computes the angular size of galaxies from their physical size.

Utility functions

angular_size

Angular size of a galaxy.

Models

early_type_lognormal	Lognormal distribution for early-type galaxies.
late_type_lognormal	Lognormal distribution for late-type galaxies.
linear_lognormal	Lognormal distribution with linear mean.

Spectra (skypy.galaxy.spectrum)

Galaxy spectrum module.

Models

dirichlet_coefficients

Dirichlet-distributed SED coefficients.

Dark Matter Halos (skypy.halo)

This module contains methods that model the properties of dark matter halo populations.

Abundance Matching (skypy.halo.abundance_matching)

Abundance matching module.

This module provides methods to perform abundance matching between catalogs of galaxies and dark matter halos.

Models

vale_ostriker

Vale & Ostriker abundance matching.

Mass (skypy.halo.mass)

Halo mass module.

This module provides methods to sample the masses of dark matter halos.

Models

press_schechter

Sampling from Press-Schechter mass function (1974).

Power Spectrum (skypy.power_spectrum)

This module contains methods that model the matter power spectrum.

Linear Power Spectrum

camb	Return the CAMB computation of the linear matter power spectrum, on a two dimensional grid of wavenumber and redshift
eisenstein_hu	Eisenstein & Hu fitting function for the linear matter power spectrum with (or without) baryon acoustic oscillations using formulation from Komatsu et al (2009).
transfer_no_wiggles	Eisenstein & Hu fitting formula for the transfer function without baryon acoustic oscillation wiggles.
transfer_with_wiggles	Eisenstein & Hu fitting formula for the transfer function with baryon acoustic oscillation wiggles.

Nonlinear Power Spectrum

HalofitParameters
halofit	Computation of the non-linear halo power spectrum.
halofit_smith	Computation of the non-linear halo power spectrum.
halofit_takahashi	Computation of the non-linear halo power spectrum.
halofit_bird	Computation of the non-linear halo power spectrum.

Growth Functions

growth_factor	Computation of the growth factor.
growth_function	Computation of the growth function.
growth_function_carroll	Computation of the growth function.
growth_function_derivative	Computation of the first derivative of the growth function.

Utils (skypy.utils)

This module contains utility functions.

Astronomy (skypy.utils.astronomy)

Astronomy utility module.

This module provides methods to convert among astronomical quantities like luminosity and magnitude.

Utility functions

luminosity_from_absolute_magnitude	Converts absolute magnitudes into luminosities
absolute_magnitude_from_luminosity	Converts luminosities into absolute magnitudes

Random sampling (skypy.utils.random)

Random utility module.

This module provides methods to draw from random distributions.

Utility Functions

schechter

Sample from the Schechter function.

Special functions (skypy.utils.special)

Special functions.

This module computes useful special functions.

Utility functions

upper_incomplete_gamma

Non-regularised upper incomplete gamma function.

Pipeline

Pipeline (skypy.pipeline)

Running SkyPy

The Pipeline package contains the functionality to run a SkyPy simulation from end to end. This is implemented in SkyPyDriver.

Reference/API

skypy.pipeline Package

This module provides methods to pipeline together multiple models with dependencies and handle their outputs.

skypy.pipeline.driver Module

Driver module.

This module provides methods to run pipelines of functions with dependencies and handle their results.

Classes

SkyPyDriver()

Class for running pipelines.

Class Inheritance Diagram

Developer Documentation

Project details

Index

• Index

• Module Index

• Search Page

Acknowledgements

Logo Credit: Maria Fonseca de la Bella