Tasks¶

Class providing general top-level tasks to be performed by Galacticus-–the primary unit of computation that the code executes when run. Each task implementation defines a self-contained operation, such as evolving a forest of merger trees to produce a galaxy catalogue, running a Bayesian parameter estimation, performing N-body analysis, or executing a radiative transfer calculation. The perform method carries out the task and optionally returns an exit status, while requiresOutputFile indicates whether HDF5 output should be opened beforehand.

Default implementation: taskEvolveForests

Methods¶

perform → void

Perform the task.

integer, intent( out), optional :: status

requiresOutputFile → logical

Should return true if the task requires the main output file to be open.

`taskAGNSpectraHopkins2008BuildFile`¶

A task which builds and caches a tabulation of AGN accretion disk spectra using the model of Hopkins et al. (2007), computing the spectral energy distribution as a function of black hole mass and accretion rate for use in subsequent galaxy evolution calculations.

`taskBuildBroadbandLuminosityTabulations`¶

A task which pre-builds and caches tabulations of stellar population broadband luminosities by evaluating the luminosity for a reference stellar population at solar metallicity. This pre-computation allows rapid lookup of broadband luminosities in photometric bands during galaxy evolution.

`taskBuildSEDTabulations`¶

A task which pre-builds and caches tabulations of stellar spectral energy distributions (SEDs) by iterating over output times and computing SED properties for a representative galaxy node. This pre-computation avoids redundant calculations during full forest evolution, covering disk, spheroid, and nuclear star cluster components.

`taskBuildTableCIECloudy`¶

A task which builds collisional ionization equilibrium tables using Cloudy.

Parameters

[fileNameCoolingFunction] (default inputPath(pathTypeDataDynamic)//'cooling/cooling_function_Atomic_CIE_Cloudy.hdf5') — The file name to which the cooling function table should be stored.
[fileNameChemicalState] (default inputPath(pathTypeDataDynamic)//'chemicalState/chemical_state_Atomic_CIE_Cloudy.hdf5') — The file name to which the chemical state table should be stored.
[metallicityLogarithmicMaximum] (default 1.5d0) — The maximum metallicity to tabulated, expressed as log-10 relative to Solar.
[includeContinuum] (default .true.) — If true include the cumulative fraction of total power emitted in the continuum.

`taskBuildToolAxionCAMB`¶

A task which downloads, compiles, and installs the AxionCAMB Boltzmann code—a modification of CAMB that supports ultralight axion dark matter—making it available for computing transfer functions and power spectra in axion cosmologies.

Methods

checkRange — Check that the provided wavenumber is within the tabulated range of the transfer function.

Parameters

[redshift] (default 0.0d0) — The redshift at which the transfer function should be evaluated.
[countPerDecade] (default 0) — The number of points per decade of wavenumber to compute in the AxionCAMB transfer function. A value of 0 allows AxionCAMB to choose what it considers to be optimal spacing of wavenumbers.

`taskBuildToolCAMB`¶

A task which downloads, compiles, and installs the CAMB (Code for Anisotropies in the Microwave Background) Boltzmann code, making it available for computing CMB power spectra, matter transfer functions, and linear matter power spectra.

Methods

checkRange — Check that the provided wavenumber is within the tabulated range of the transfer function.

Parameters

[transferFunctionType] (default var_str('darkMatter')) — Specifies whether to use the darkMatter or total transfer function.
[redshift] (default 0.0d0) — The redshift at which the transfer function should be evaluated.
[cambCountPerDecade] (default 0) — The number of points per decade of wavenumber to compute in the CAMB transfer function. A value of 0 allows CAMB to choose what it considers to be optimal spacing of wavenumbers.

`taskBuildToolCLASS`¶

A task which downloads, compiles, and installs the CLASS (Cosmic Linear Anisotropy Solving System) Boltzmann code, making it available as an alternative to CAMB for computing CMB anisotropies, matter transfer functions, and linear power spectra.

`taskBuildToolCloudy`¶

A task which downloads, compiles, and installs the Cloudy photoionization and spectral synthesis code, making it available for computing cooling functions, chemical state tables, and emission line strengths of astrophysical plasmas.

`taskBuildToolFSPS`¶

A task which downloads, compiles, and installs the FSPS (Flexible Stellar Population Synthesis) code, making it available for computing stellar population spectral energy distributions and broadband luminosities from star formation histories.

Parameters

[forceZeroMetallicity] (default .false.) — Force the use of zero metallicity (or lowest metallicity available) for all stellar populations.

`taskBuildToolMangle`¶

A task which downloads, compiles, and installs the mangle angular mask software, making it available for defining and manipulating survey angular geometries used in galaxy clustering and correlation function analyses.

Methods

mangleDirectory — Return the directory containing mangle files for this survey geometry.
mangleFiles — Return array of mangle filenames for this survey geometry.
initialize — Initialize an instance of the mangle survey geometry class.

`taskBuildToolRecFast`¶

A task which downloads, compiles, and installs the RecFast recombination code, making it available for computing the ionization history of the universe during hydrogen and helium recombination for use in Boltzmann solvers and CMB calculations.

`taskCatalogProjectedCorrelationFunction`¶

A task which reads a galaxy catalog from an IRATE-format N-body halo file, applies a survey geometry mask, shifts galaxies into redshift space, and computes the projected two-point correlation function \(w_\mathrm{p}(r_\mathrm{p})\) by integrating the 3D correlation function along the line of sight to a maximum separation \(\pi_\mathrm{max}\).

Parameters

[galaxyCatalogFileName] — The file name from which the galaxy catalog should be read.
[massMinimum] (default 0.0d0) — The minimum mass galaxy to include in a mock catalog correlation function calculation.
[massMaximum] (default 1.0d16) — The maximum mass galaxy to include in a mock catalog correlation function calculation.
[separationMinimum] (default 0.1d0) — The minimum separation to compute in a mock catalog correlation function calculation.
[separationMaximum] (default 30.0d0) — The maximum separation to compute in a mock catalog correlation function calculation.
[separationCount] (default 15) — The number of bins in separation to compute in a mock catalog correlation function calculation.
[randomSampleCount] (default var_str('*10')) — The number of random points to use when constructing random catalogs. Can be either a fixed number or, if prefixed with “*”, a multiplicative factor.
[separationRadialMaximum] (default 40.0d0) — The maximum radial separation of galaxies to consider when computing projected correlation functions.
[halfIntegral] (default .false.) — Set to true if the projected correlation function is computed as \(w_\mathrm{p}(r_\mathrm{p})=\int_0^{+\pi_\mathrm{max}} \xi(r_\mathrm{p},\pi) \mathrm{d} \pi\), instead of the usual \(w_\mathrm{p}(r_\mathrm{p})=\int_{-\pi_\mathrm{max}}^{+\pi_\mathrm{max}} \xi(r_\mathrm{p},\pi) \mathrm{d} \pi\).
[widthBuffer] (default 30.0d0) — The width of the buffer region around survey geometry to ensure galaxies are not lost when moving to redshift space.
[origin] (default [randomNumberGenerator_%uniformSample(),randomNumberGenerator_%uniformSample(),randomNumberGenerator_%uniformSample()]) — The vector (in units of the box length) giving the origin of the coordinate system to use in mock catalog construction.
[vectorRotation] (default [acos(2.0d0*randomNumberGenerator_%uniformSample()-1.0d0),2.0d0*Pi*randomNumberGenerator_%uniformSample()]) — The vector, in spherical coordinates \((\theta,\phi)\), about which the mock catalog should be rotated.
[angleRotation] (default 2.0d0*Pi*randomNumberGenerator_%uniformSample()) — The angle through which the mock catalog should be rotated.

`taskComovingDistances`¶

A task which computes and outputs the comoving distance to each output.

`taskConditionalMassFunction`¶

A task which computes the conditional mass function in bins of mass for a fixed halo mass.

Methods

binWeights — Compute weights for a halo in each bin of the mass function.
binWeights2D — Compute weights for a halo in each bin of a 2D mass function.

Parameters

[countMassParent] (default 10) — The number of bins in parent mass when constructing conditional halo mass functions.
[massParentMinimum] (default 1.0d10) — The minimum parent halo mass to bin when constructing conditional halo mass functions.
[massParentMaximum] (default 1.0d15) — The maximum parent halo mass to bin when constructing conditional halo mass functions.
[massRatioCount] (default 10) — The number of bins in mass ratio when constructing conditional halo mass functions.
[massRatioMinimum] (default 1.0d-4) — The minimum mass ratio to bin when constructing conditional halo mass functions.
[massRatioMaximum] (default 1.0d1) — The maximum mass ratio to bin when constructing conditional halo mass functions.
[redshiftsParent] (default [0.0d0]) — The set of parent halo redshifts to use when constructing conditional halo mass functions.
[redshiftsProgenitor] (default [1.0d0]) — The set of progenitor halo redshifts to use when constructing conditional halo mass functions.
[depthProgenitorPrimary] (default 2) — The depth in progenitor ranking for which to store ranked progenitor mass functions. For example, a value of 2 means store mass functions for the most massive, and second most massive progenitor.
[depthHierarchySubhalo] (default 2) — The depth in the subhalo hierarchy for which to store unevolved subhalo mass functions.
[fractionTimeFormationRate] (default 0.01d0) — The fraction of the current time over which to estimate the formation rate of halos when computing merger tree statistics.
[alwaysIsolatedHalosOnly] (default .false.) — Include only halos which have always been isolated when computing merger tree statistics?
[extendedStatistics] (default .true.) — Compute extended statistics (formation rate function, \(N^\mathrm{th}\) most-massive progenitor mass functions, etc.)?
[computeCovariances] (default .false.) — Compute covariances for accumulated statistics?
[nameGroupOutput] (default var_str('conditionalMassFunction')) — The name of the HDF5 group to which the conditional mass function should be output.
[outputGroupName] — The name of the file to which the computed conditional mass function should be output.
[redshiftMinimum] (default 0.0d0) — The minimum redshift for which to compute the conditional mass function.
[redshiftMaximum] (default 0.0d0) — The maximum redshift for which to compute the conditional mass function.
[useSurveyLimits] (default .false.) — Specifies whether the limiting redshifts for integrating over the halo mass function should be limited by those of a galaxy survey.
[massBinCenters] — Logarithmic mass bins centers for conditional mass function calculations.
[massLogarithmDelta] — Logarithmic widths of mass bins for conditional mass function calculations.
[massMinimum] (default 1.0d8) — The minimum mass for which to compute the conditional mass function.
[massMaximum] (default 1.0d12) — The maximum mass for which to compute the conditional mass function.
[countMass] (default 21) — The number of bins for which to compute the conditional mass function.
[massHalo] (default var_str('all')) — The halo mass for which to compute the conditional mass function. A value of “all” will cause the conditional mass function to be integrated over the halo mass function, giving the mass function.
[massHaloMinimum] (default 1.0d6) — The minimum halo mass to use when integrating over the halo mass function.
[massHaloMaximum] (default 1.0d16) — The maximum halo mass to use when integrating over the halo mass function.

`taskEvolveForests`¶

A task which evolves galaxies within a set of merger tree forests.

(Default implementation)

Methods

tabulate — Tabulate the virial density contrast as a function of mass and time.
restoreTable — Restore a tabulated solution from file.
storeTable — Store a tabulated solution to file.

Parameters

[velocityCharacteristic] (default 250.0d0) — The velocity scale at which the SNe-driven outflow rate equals the star formation rate in disks.
[exponent] (default 3.5d0) — The velocity scaling of the SNe-driven outflow rate in disks.
[fraction] (default 0.01d0) — The normalization \(f\) of the outflow rate relative to the star formation rate at a reference halo velocity of 200 km/s and expansion factor of 1, setting the overall mass-loading amplitude of the halo-scaling feedback model.
[exponentVelocity] (default -2.0d0) — The exponent of virial velocity in the outflow rate in disks.
[exponentRedshift] (default 0.0d0) — The power-law exponent of the cosmological expansion factor \((1+z)\) in the halo-scaling outflow rate, allowing the mass-loading factor to evolve with redshift; a value of zero gives no redshift evolution.
[toleranceRelativeVelocityDispersion] (default 1.0d-6) — The relative tolerance to use in numerical solutions for the velocity dispersion in dark-matter-only density profiles.
[toleranceRelativeVelocityDispersionMaximum] (default 1.0d-3) — The maximum relative tolerance to use in numerical solutions for the velocity dispersion in dark-matter-only density profiles.
[radiusNormalization] (default 3.3d-6) — The initial value appearing in the radius-mass relation
[toleranceAbsoluteMass] (default 1.0d-6) — The mass tolerance used to judge whether the nuclear star cluster is physically plausible.
[toleranceRelativeMetallicity] (default 1.0d-4) — The metallicity tolerance for ODE solution.
[inactiveLuminositiesStellar] (default .false.) — Specifies whether or not nuclear star cluster stellar luminosities are inactive properties (i.e. do not appear in any ODE being solved).
[scaleRelativeMass] (default 1.0d-2) — The mass scale, relative to the total mass of the node, below which calculations in the delayed very simple hot halo component are allowed to become inaccurate.
[starveSatellites] (default .false.) — Specifies whether or not the hot halo should be removed (“starved”) when a node becomes a satellite.
[starveSatellitesOutflowed] (default .false.) — Specifies whether or not the outflowed hot halo should be removed (“starved”) when a node becomes a satellite.
[outflowReturnOnFormation] (default .false.) — Specifies whether or not outflowed gas should be returned to the hot reservoir on halo formation events.
[angularMomentumAlwaysGrows] (default .false.) — Specifies whether or not negative rates of accretion of angular momentum into the hot halo will be treated as positive for the purposes of computing the hot halo angular momentum.
[fractionBaryonLimitInNodeMerger] (default .false.) — Controls whether the hot gas content of nodes should be limited to not exceed the universal baryon fraction at node merger events. If set to true, hot gas (and angular momentum, abundances, and chemicals proportionally) will be removed from the merged halo to the unaccreted gas reservoir to limit the baryonic mass to the universal baryon fraction where possible.
[scaleAbsoluteMass] (default 100.0d0) — The absolute mass scale below which calculations in the very simple disk component are allowed to become inaccurate.
[toleranceAbsoluteMass] (default 1.0d-6) — The mass tolerance used to judge whether the disk is physically plausible.
[toleranceAbsoluteMass] (default 1.0d-6) — The mass tolerance used to judge whether the disk is physically plausible.
[toleranceRelativeMetallicity] (default 1.0d-4) — The metallicity tolerance for ODE solution.
[radiusStructureSolver] (default 1.0d0) — The radius (in units of the standard scale length) to use in solving for the size of the disk.
[structureSolverUseCole2000Method] (default .false.) — If true, use the method described in Cole et al. (2000) to correct for difference between thin disk and spherical mass distributions when solving for disk radii.
[diskNegativeAngularMomentumAllowed] (default .true.) — Specifies whether or not negative angular momentum is allowed for the disk.
[inactiveLuminositiesStellar] (default .false.) — Specifies whether or not disk stellar luminosities are inactive properties (i.e. do not appear in any ODE being solved).
[postStepZeroNegativeMasses] (default .true.) — If true, negative masses will be zeroed after each ODE step. Note that this can lead to non-conservation of mass.
[ratioAngularMomentumSolverRadius] (default ratioAngularMomentumSolverRadiusDefault) — The assumed ratio of the specific angular momentum at the structure solver radius to the mean specific angular momentum of the standard disk component.
[scaleAbsoluteMass] (default 100.0d0) — The absolute mass scale below which calculations in the very simple spheroid component are allowed to become inaccurate.
[toleranceAbsoluteMass] (default 1.0d-6) — The mass tolerance used to judge whether the spheroid is physically plausible.
[efficiencyEnergeticOutflow] (default 1.0d-2) — The proportionality factor relating mass outflow rate from the spheroid to the energy input rate divided by \(V_\mathrm{spheroid}^2\).
[toleranceRelativeMetallicity] (default 1.0d-4) — The metallicity tolerance for ODE solution.
[toleranceAbsoluteMass] (default 1.0d-6) — The mass tolerance used to judge whether the spheroid is physically plausible.
[inactiveLuminositiesStellar] (default .false.) — Specifies whether or not spheroid stellar luminosities are inactive properties (i.e. do not appear in any ODE being solved).
[postStepZeroNegativeMasses] (default .true.) — If true, negative masses will be zeroed after each ODE step. Note that this can lead to non-conservation of mass.
[ratioAngularMomentumScaleRadius] (default ratioAngularMomentumScaleRadiusDefault) — The assumed ratio of the specific angular momentum at the scale radius to the mean specific angular momentum of the standard spheroid component.
[outputMergers] (default .false.) — Determines whether or not properties of black hole mergers will be output.
[fileNames] — The name of the file(s) from which merger tree data should be read when using the [mergerTreeConstruct]\(=\)read tree construction method.
[forestSizeMaximum] (default 0_c_size_t) — The maximum number of nodes allowed in a forest before it will be broken up into trees and processed individually. A value of 0 implies that forests should never be split.
[presetMergerTimes] (default .true.) — Specifies whether merging times for subhalos should be preset when reading merger trees from a file.
[presetMergerNodes] (default .true.) — Specifies whether the target nodes for mergers should be preset (i.e. determined from descendant nodes). If they are not, merging will be with each satellite’s host node.
[presetSubhaloMasses] (default .true.) — Specifies whether subhalo mass should be preset when reading merger trees from a file.
[subhaloAngularMomentaMethod] (default var_str('summation')) — Specifies how to account for subhalo angular momentum when adding subhalo mass to host halo mass.
[presetSubhaloIndices] (default .true.) — Specifies whether subhalo indices should be preset when reading merger trees from a file.
[presetPositions] (default .true.) — Specifies whether node positions should be preset when reading merger trees from a file.
[presetScaleRadii] (default .true.) — Specifies whether node scale radii should be preset when reading merger trees from a file.
[scaleRadiiFailureIsFatal] (default .true.) — Specifies whether failure to set a node scale radii should be regarded as a fatal error. (If not, a fallback method to set scale radius is used in such cases.)
[presetScaleRadiiConcentrationMinimum] (default 3.0d0) — The lowest concentration (\(c=r_\mathrm{vir}/r_\mathrm{s}\)) allowed when setting scale radii, \(r_\mathrm{s}\).
[presetScaleRadiiConcentrationMaximum] (default 60.0d0) — The largest concentration (\(c=r_\mathrm{vir}/r_\mathrm{s}\)) allowed when setting scale radii, \(r_\mathrm{s}\).
[presetScaleRadiiMinimumMass] (default 0.0d0) — The minimum halo mass for which scale radii should be preset (if [presetScaleRadii]\(=\)true).
[presetUnphysicalAngularMomenta] (default .false.) — When reading merger trees from file and presetting halo angular momenta, detect unphysical (<=0) angular momenta and preset them using the selected halo spin method.
[presetAngularMomenta] (default .true.) — Specifies whether node angular momenta should be preset when reading merger trees from a file.
[presetAngularMomenta3D] (default .false.) — Specifies whether node 3-D angular momenta vectors should be preset when reading merger trees from a file.
[presetOrbits] (default .true.) — Specifies whether node orbits should be preset when reading merger trees from a file.
[presetOrbitsSetAll] (default .true.) — Forces all orbits to be set. If the computed orbit does not cross the virial radius, then select one at random instead.
[presetOrbitsAssertAllSet] (default .true.) — Asserts that all virial orbits must be preset. If any can not be set, Galacticus will stop.
[presetOrbitsBoundOnly] (default .true.) — Specifies whether only bound node orbits should be set.
[beginAt] (default -1_kind_int8) — Specifies the index of the tree to begin at. (Use -1 to always begin with the first tree.)
[outputTimeSnapTolerance] (default 0.0d0) — The relative tolerance required to “snap” a node time to the closest output time.
[missingHostsAreFatal] (default .true.) — Specifies whether nodes with missing host nodes should be considered to be fatal—see the discussion of missing host nodes in the class description above.
[treeIndexToRootNodeIndex] (default .false.) — Specifies whether tree indices should always be set to the index of their root node.
[allowBranchJumps] (default .true.) — Specifies whether nodes are allowed to jump between branches.
[allowSubhaloPromotions] (default .true.) — Specifies whether subhalos are permitted to be promoted to being isolated halos.
[alwaysPromoteMostMassive] (default .false.) — If true, the most massive progenitor is always promoted to be the primary progenitor even if it is a subhalo. Otherwise, isolated progenitors are given priority over subhalo progenitors, even if they are less massive.
[presetNamedReals] — Names of real datasets to be additionally read and stored in the nodes of the merger tree when using the [mergerTreeConstruct]\(=\)read tree construction method.
[presetNamedIntegers] — Names of integer datasets to be additionally read and stored in the nodes of the merger tree when using the [mergerTreeConstruct]\(=\)read tree construction method.
[fatalMismatches] (default .true.) — Specifies whether mismatches in cosmological parameter values between Galacticus and “Sussing Merger Trees” format (Srisawat et al., 2013) merger tree files should be considered fatal.
[fatalNonTreeNode] (default .true.) — Specifies whether nodes in snapshot files but not in the merger tree file should be considered fatal when importing from the “Sussing Merger Trees” format (Srisawat et al., 2013).
[subvolumeCount] (default 1) — Specifies the number of subvolumes along each axis into which a “Sussing Merger Trees” format (Srisawat et al., 2013) merger tree files should be split for processing through Galacticus.
[subvolumeBuffer] (default 0.0d0) — Specifies the buffer region (in units of Mpc\(/h\) to follow the format convention) around subvolumes of a “Sussing Merger Trees” format (Srisawat et al., 2013) merger tree file which should be read in to ensure that no halos are missed from trees.
[subvolumeIndex] (default [0,0,0]) — Specifies the index (in each dimension) of the subvolume of a “Sussing Merger Trees” format (Srisawat et al., 2013) merger tree file to process. Indices range from 0 to [subvolumeCount]\(-1\).
[badValue] (default -0.5d0) — Use for bad value detection in “Sussing” merger trees. Values for scale radius and halo spin which exceed this threshold are assumed to be bad.
[badValueTest] (default var_str('lessThan')) — Use for bad value detection in “Sussing” merger trees. Values which exceed the threshold in ths specified direction are assumed to be bad.
[treeSampleRate] (default 1.0d0) — Specify the probability that any given tree should processed (to permit subsampling).
[massOptions] (default var_str('default')) — Mass option for Sussing merger trees.
[mergeProbability] (default 0.1d0) — The largest probability of branching allowed in a timestep in merger trees built by the Cole et al. (2000) method.
[accretionLimit] (default 0.1d0) — The largest fractional mass change due to subresolution accretion allowed in a timestep in merger trees built by the Cole et al. (2000) method.
[redshiftMaximum] (default 1.0d5) — The highest redshift to which merger trees will be built in the Cole et al. (2000) method.
[toleranceTimeEarliest] (default 2.0d-6) — The fractional tolerance used to judge if a branch is at the earliest allowed time in the tree.
[branchIntervalStep] (default .true.) — If false use the original Cole et al. (2000) method to determine whether branching occurs in a timestep. If true draw branching intervals from a negative exponential distribution.
[toleranceResolutionSelf] (default 1.0d-6) — The fractional tolerance in node mass at the resolution limit below which branch mis-orderings will be ignored.
[toleranceResolutionParent] (default 1.0d-3) — The fractional tolerance in parent node mass at the resolution limit below which branch mis-orderings will be ignored.
[ignoreNoProgress] (default .false.) — If true, failure to make progress on a branch will be ignored (and the branch terminated).
[ignoreWellOrdering] (default .false.) — If true, non-well-ordered tree branches are pruned away instead of causing errors..
[redshiftBase] (default 0.0d0) — The redshift at which to plant the base node when building merger trees.
[timeSnapTolerance] (default 1.0d-6) — The fractional tolerance within which the tree base time will be snapped to a nearby output time.
[treeBeginAt] (default 0) — The index (in order of increasing base halo mass) of the tree at which to begin when building merger trees. A value of “0” means to begin with tree number 1 (if processing trees in ascending order), or equal to the number of trees (otherwise).
[processDescending] (default .true.) — If true, causes merger trees to be processed in order of decreasing mass.
[splitTrees] (default .false.) — If true, prune away any nodes of the tree that are not needed to determine evolution up to the latest time at which a node is present inside the lightcone. This typically leads to a tree splitting into a forest of trees.
[label] — A label for the mass function.
[comment] — A descriptive comment for the mass function.
[starFormationRates] — The star formation rates corresponding to bin centers.
[covarianceBinomialBinsPerDecade] (default 10) — The number of bins per decade of star formation rate to use when constructing star formation rate function covariance matrices for main branch galaxies.
[covarianceBinomialMassHaloMinimum] (default 1.0d10) — The star formation rate to consider when constructing star formation rate function covariance matrices for main branch galaxies.
[covarianceBinomialMassHaloMaximum] (default 1.0d12) — The maximum star formation rate to consider when constructing star formation rate function covariance matrices for main branch galaxies.
[targetLabel] — Label for the target dataset.
[functionValueTarget] — The target function for likelihood calculations.
[functionCovarianceTarget] — The target function covariance for likelihood calculations.
[likelihoodBins] — Controls which bins in the stellar mass–halo mass relation will be used in computing the likelihood: * not present: all bins are included in the likelihood calculation; * list of integers: use only the mass bin(s) given in this list in the likelihood calculation; * auto: use only bins which have a non-zero number of halos contributing to them in the likelihood calculation.
[fileNameTarget] — The name of the file containing the target data.
[redshiftInterval] (default 1) — The redshift interval to use.
[likelihoodNormalize] (default .false.) — If true, then normalize the likelihood to make it a probability density.
[computeScatter] (default .false.) — If true, the scatter in log10(stellar mass) is computed. Otherwise, the mean is computed.
[systematicErrorPolynomialCoefficient] (default [0.0d0]) — The coefficients of the systematic error polynomial for stellar mass in the stellar vs halo mass relation.
[systematicErrorMassHaloPolynomialCoefficient] (default [0.0d0]) — The coefficients of the systematic error polynomial for halo mass in the stellar vs halo mass relation.
[errorTolerant] (default .false.) — Error tolerance for the N-body spin distribution operator.
[logNormalRange] (default 100.0d0) — The multiplicative range of the log-normal distribution used to model the distribution of the mass and energy terms in the spin parameter. Specifically, the lognormal distribution is truncated outside the range \((\lambda_\mathrm{m}/R,\lambda_\mathrm{m} R\), where \(\lambda_\mathrm{m}\) is the measured spin, and \(R=\)[logNormalRange]
[fileName] — The name of the file from which to read spin distribution function parameters.
[comment] — A comment describing this analysis.
[label] — A label for this analysis.
[label] — A label for the spin distribution function.
[comment] — A descriptive comment for the spin distribution function.
[redshift] — The redshift at which to compute the spin distribution function.
[massMinimum] — Minimum halo mass for the spin distribution function.
[massMaximum] — Maximum halo mass for the spin distribution function.
[spinMinimum] — Minimum spin for the spin distribution function.
[spinMaximum] — Maximum spin for the spin distribution function.
[countSpinsPerDecade] — Number of spins per decade at which to compute the spin distribution function.
[timeRecent] — Halos which experienced a major node merger within a time \(\Delta t=\)[timeRecent] of the analysis time will be excluded from the analysis.
[particleCountMinimum] — The minimum particle count to assume when computing N-body errors on spins.
[massParticle] — The mass of the particle used in the N-body simulation from which spins were measured.
[energyEstimateParticleCountMaximum] — The maximum number of particles used in estimating halo energies when measuring spins from the N-body simulation.
[targetLabel] — Label for the target dataset.
[functionValueTarget] — The target function for likelihood calculations.
[functionCovarianceTarget] — The target function covariance for likelihood calculations.
[label] — A label for the mass function.
[comment] — A descriptive comment for the mass function.
[masses] — The masses corresponding to bin centers.
[covarianceBinomialBinsPerDecade] (default 10) — The number of bins per decade of halo mass to use when constructing HI mass function covariance matrices for main branch galaxies.
[covarianceBinomialMassHaloMinimum] (default 1.0d8) — The minimum halo mass to consider when constructing HI mass function covariance matrices for main branch galaxies.
[covarianceBinomialMassHaloMaximum] (default 1.0d16) — The maximum halo mass to consider when constructing HI mass function covariance matrices for main branch galaxies.
[targetLabel] — Label for the target dataset.
[functionValueTarget] — The target function for likelihood calculations.
[functionCovarianceTarget] — The target function covariance for likelihood calculations.
[label] — A label for the luminosity function.
[comment] — A descriptive comment for the luminosity function.
[magnitudesAbsolute] — The absolute magnitudes corresponding to bin centers.
[covarianceBinomialBinsPerDecade] (default 10) — The number of bins per decade of halo mass to use when constructing luminosity function covariance matrices for main branch galaxies.
[covarianceBinomialMassHaloMinimum] (default 1.0d8) — The minimum halo mass to consider when constructing luminosity function covariance matrices for main branch galaxies.
[covarianceBinomialMassHaloMaximum] (default 1.0d16) — The maximum halo mass to consider when constructing luminosity function covariance matrices for main branch galaxies.
[targetLabel] — Label for the target dataset.
[functionValueTarget] — The target function for likelihood calculations.
[functionCovarianceTarget] — The target function covariance for likelihood calculations.
[label] — A label for the luminosity function.
[comment] — A descriptive comment for the luminosity function.
[luminosities] — The luminosities corresponding to bin centers.
[covarianceBinomialBinsPerDecade] (default 10) — The number of bins per decade of halo mass to use when constructing luminosity function covariance matrices for main branch galaxies.
[covarianceBinomialMassHaloMinimum] (default 1.0d8) — The minimum halo mass to consider when constructing luminosity function covariance matrices for main branch galaxies.
[covarianceBinomialMassHaloMaximum] (default 1.0d16) — The maximum halo mass to consider when constructing luminosity function covariance matrices for main branch galaxies.
[includeNitrogenII] (default .false.) — If true, include contamination by the [NII] (6548AA \(+\) 6584AA) doublet.
[depthOpticalISMCoefficient] (default 1.0d0) — Multiplicative coefficient for optical depth in the ISM.
[targetLabel] — Label for the target dataset.
[functionValueTarget] — The target function for likelihood calculations.
[functionCovarianceTarget] — The target function covariance for likelihood calculations.
[label] — A label for the mass function.
[comment] — A descriptive comment for the mass function.
[masses] — The masses corresponding to bin centers.
[covarianceBinomialBinsPerDecade] (default 10) — The number of bins per decade of halo mass to use when constructing stellar mass function covariance matrices for main branch galaxies.
[covarianceBinomialMassHaloMinimum] (default 1.0d8) — The minimum halo mass to consider when constructing stellar mass function covariance matrices for main branch galaxies.
[covarianceBinomialMassHaloMaximum] (default 1.0d16) — The maximum halo mass to consider when constructing stellar mass function covariance matrices for main branch galaxies.
[targetLabel] — Label for the target dataset.
[functionValueTarget] — The target function for likelihood calculations.
[functionCovarianceTarget] — The target function covariance for likelihood calculations.
[rootVarianceFractionalMinimum] (default 0.0d0) — The minimum fractional root variance (relative to the target dataset).
[fileName] — The name of the file from which to read concentration distribution function parameters.
[comment] — A comment describing this analysis.
[label] — A label for this analysis.
[label] — A label for the concentration distribution function.
[comment] — A descriptive comment for the concentration distribution function.
[redshift] — The redshift at which to compute the concentration distribution function.
[massMinimum] — Minimum halo mass for the concentration distribution function.
[massMaximum] — Maximum halo mass for the concentration distribution function.
[concentrationMinimum] — Minimum concentration for the concentration distribution function.
[concentrationMaximum] — Maximum concentration for the concentration distribution function.
[countConcentrationsPerDecade] — Number of concentrations per decade at which to compute the concentration distribution function.
[timeRecent] — Halos which experienced a major node merger within a time \(\Delta t=\)[timeRecent] of the analysis time will be excluded from the analysis.
[massParticle] — The particle mass in the source N-body simulation.
[targetLabel] — Label for the target dataset.
[functionValueTarget] — The target function for likelihood calculations.
[functionCovarianceTarget] — The target function covariance for likelihood calculations.
[fileName] — The name of the file from which to read star forming main sequence function parameters.
[comment] — A comment describing this analysis.
[label] — A label for this analysis.
[label] — A label for the star forming main sequence function.
[comment] — A descriptive comment for the star forming main sequence function.
[massMinimum] — Minimum stellar mass for the star forming main sequence function.
[massMaximum] — Maximum stellar mass for the star forming main sequence function.
[countMassesPerDecade] — Number of masses per decade at which to compute the star forming main sequence function.
[targetLabel] — Label for the target dataset.
[meanValueTarget] — The target function for likelihood calculations.
[meanCovarianceTarget] — The target function covariance for likelihood calculations.
[label] — A label for the mass function.
[comment] — A descriptive comment for the mass function.
[separations] — The separations corresponding to bin centers.
[massMinima] — The minimum mass of each mass sample.
[massMaxima] — The maximum mass of each mass sample.
[massHaloBinsPerDecade] (default 10) — The number of bins per decade of halo mass to use when constructing the mass function covariance matrix for main branch galaxies.
[massHaloMinimum] (default 1.0d8) — The minimum halo mass to consider when constructing the mass function covariance matrix for main branch galaxies.
[massHaloMaximum] (default 1.0d16) — The maximum halo mass to consider when constructing the mass function covariance matrix for main branch galaxies.
[wavenumberCount] (default 60_c_size_t) — The number of bins in wavenumber to use in computing the correlation function.
[wavenumberMinimum] (default 1.0d-3) — The minimum wavenumber to use when computing the correlation function.
[wavenumberMaximum] (default 1.0d4) — The maximum wavenumber to use when computing the correlation function.
[integralConstraint] — The integral constraint for these correlation functions.
[depthLineOfSight] — The line-of-sight depth over which the correlation function was projected.
[halfIntegral] — Set to true if the projection integrand should be over line-of-sight depths greater than zero.
[binnedProjectedCorrelationTarget] — The target function for likelihood calculations.
[binnedProjectedCorrelationCovarianceTarget] — The target function covariance for likelihood calculations.
[targetLabel] (default var_str('')) — A label for the target dataset in a plot of this analysis.
[starFormationRateSpecificQuiescentLogarithmic] — The base-10 logarithm specific star formation rate (in units of Gyr\(^{-1}\)) separating quiescent and star-forming galaxies.
[starFormationRateSpecificLogarithmicError] — The observational fractional error in specific star formation rate (in units of dex) of galaxies.
[fileName] — The name of the file from which to read quiescent fraction function parameters.
[comment] — A comment describing this analysis.
[label] — A label for this analysis.
[label] — A label for the star forming main sequence function.
[comment] — A descriptive comment for the star forming main sequence function.
[massMinimum] — Minimum stellar mass for the star forming main sequence function.
[massMaximum] — Maximum stellar mass for the star forming main sequence function.
[countMassesPerDecade] — Number of masses per decade at which to compute the star forming main sequence function.
[targetLabel] — Label for the target dataset.
[meanValueTarget] — The target function for likelihood calculations.
[meanCovarianceTarget] — The target function covariance for likelihood calculations.
[nonAnalyticSolver] (default var_str('fallThrough')) — Selects how solutions are computed when no analytic solution is available. If set to “fallThrough” then the solution ignoring heating is used, while if set to “numerical” then numerical solvers are used to find solutions.
[radiusFractionalTruncateMinimum] (default 2.0d0) — The minimum radius (in units of the virial radius) to begin truncating the density profile.
[radiusFractionalTruncateMaximum] (default 4.0d0) — The maximum radius (in units of the virial radius) to finish truncating the density profile.
[nonAnalyticSolver] (default var_str('fallThrough')) — Selects how solutions are computed when no analytic solution is available. If set to “fallThrough” then the solution ignoring heating is used, while if set to “numerical” then numerical solvers are used to find solutions.
[velocityDispersionApproximate] (default .true.) — If true, radial velocity dispersion is computed using an approximate method in which we assume that \(\sigma_\mathrm{r}^2(r) \rightarrow \sigma_\mathrm{r}^2(r) - (2/3) \epsilon(r)\), where \(\epsilon(r)\) is the specific heating energy. If false then radial velocity dispersion is computed by numerically solving the Jeans equation.
[tolerateEnclosedMassIntegrationFailure] (default .false.) — If true, tolerate failures to find the mass enclosed as a function of radius.
[tolerateVelocityDispersionFailure] (default .false.) — If true, tolerate failures to compute the velocity dispersion.
[tolerateVelocityMaximumFailure] (default .false.) — If true, tolerate failures to find the radius of the maximum circular velocity.
[toleratePotentialIntegrationFailure] (default .false.) — If true, tolerate numerical failures when computing the gravitational potential of a heated dark matter profile, allowing the calculation to continue with a fallback result rather than aborting.
[toleranceRelativeVelocityDispersion] (default 1.0d-6) — The relative tolerance to use in numerical solutions for the velocity dispersion in dark-matter-only density profiles.
[toleranceRelativeVelocityDispersionMaximum] (default 1.0d-3) — The maximum relative tolerance to use in numerical solutions for the velocity dispersion in dark-matter-only density profiles.
[fractionRadiusFinalSmall] (default 1.0d-3) — The initial radius is limited to be no smaller than this fraction of the final radius. This can help avoid problems in profiles that are extremely close to being disrupted.
[toleranceRelativePotential] (default 1.0d-3) — The maximum allowed relative tolerance to use in numerical solutions for the gravitational potential in dark-matter-only density profiles before aborting.
[tolerateVelocityMaximumFailure] (default .true.) — If true, tolerate failures to find the radius of the peak in the rotation curve.
[lengthResolution] — The gravitational softening length \(\Delta x\) (in Mpc) of the N-body simulation, which sets the minimum spatial scale below which the dark matter profile is smoothed to avoid artificial two-body effects.
[massResolution] — The mass resolution \(\Delta M\) (in \(\mathrm{M}_\odot\)) of the N-body simulation, representing the minimum halo mass that can be resolved; profiles of halos near this limit are softened to account for particle discreteness effects.
[resolutionIsComoving] — If true, the resolution length is assumed to be fixed in comoving coordinates, otherwise in physical coordinates.
[nonAnalyticSolver] (default var_str('fallThrough')) — Selects how solutions are computed when no analytic solution is available. If set to “fallThrough” then the solution ignoring heating is used, while if set to “numerical” then numerical solvers are used to find solutions.
[C] (default 400.0d0) — The parameter \(C\) appearing in the halo concentration algorithm of Ludlow et al. (2016).
[f] (default 0.02d0) — The parameter \(f\) appearing in the halo concentration algorithm of Ludlow et al. (2016).
[timeFormationSeekDelta] (default 0.0d0) — The parameter \(\Delta \log t\) by which the logarithm of the trial formation time is incremented when stepping through the formation history of a node to find the formation time. If set to zero (or a negative value) the cumulative mass histories of nodes are assumed to be monotonic functions of time, and the formation time is instead found by a root finding algorithm,
[massBoundIsInactive] (default .false.) — Specifies whether or not the bound mass of the satellite component is inactive (i.e. does not appear in any ODE being solved).
[useLastIsolatedTime] (default .false.) — If true, evaluate the halo virial radius using a the virial density definition at the last isolated time of the halo.
[filterName] — The filter to select.
[filterType] — The filter type (rest or observed) to select.
[redshiftBand] — The redshift of the band (if not the output redshift).
[postprocessChain] — The postprocessing chain to use.
[cloudyTableFileName] (default var_str('%DATASTATICPATH%/hiiRegions/emissionLineLuminosities_BC2003_highResolution_imfChabrier.hdf5')) — The file of emission line luminosities to use.
[lineNames] — The emission lines to extract.
[component] — The component from which to extract star formation rate.
[toleranceRelative] (default 1.0d-3) — The relative tolerance used in integration over stellar population spectra.
[component] — The component from which to extract star formation rate.
[radiusCore] — The soliton core radius (in Mpc) characterizing the size of the quantum pressure-supported central core of the fuzzy dark matter halo; the density profile flattens inside this scale.
[densitySolitonCentral] — The central density (in \(\mathrm{M}_\odot\)/Mpc\(^3\)) of the solitonic core at \(r=0\), which sets the overall normalization of the density profile \(\rho(r) = \rho_\mathrm{c} [1+(r/r_c)^2]^{-8}\).
[toleranceRelativePotential] (default 1.0d-3) — The relative tolerance used in numerical ODE solutions for the gravitational potential of the solitonic core profile.
[dimensionless] (default .true.) — If true the soliton profile is treated as dimensionless (scale-free), allowing its radial and density quantities to be specified in arbitrary units.
[componentType] (default var_str('unknown')) — The galactic structure component type (e.g.dark matter halo, disk, spheroid) represented by this mass distribution, used for component-specific queries.
[massType] (default var_str('unknown')) — The mass type (e.g.dark matter, baryonic, total) represented by this mass distribution, used for mass-type-specific queries.
[radiusTransition] — The transition radius (in Mpc) at which the density profile smoothly switches from the halo profile to the accretion flow, controlled by the fourth-order transition function \(f_\mathrm{trans}(r)\).
[nonAnalyticSolver] (default var_str('fallThrough')) — Selects how solutions are computed when no analytic solution is available. If set to “fallThrough” then the solution ignoring heating is used, while if set to “numerical” then numerical solvers are used to find solutions.
[componentType] (default var_str('unknown')) — The component type that this mass distribution represents.
[massType] (default var_str('unknown')) — The mass type that this mass distribution represents.
[timeAge] — The age of the halo (in Gyr) since its formation, determining the total time available for SIDM self-interactions to thermalize the inner halo and produce an isothermal core.
[velocityRelativeMean] — Mean relative velocity to calculate self interaction cross section.
[nonAnalyticSolver] (default var_str('fallThrough')) — Selects how solutions are computed when no analytic solution is available. If set to “fallThrough” then the solution ignoring heating is used, while if set to “numerical” then numerical solvers are used to find solutions.
[componentType] (default var_str('unknown')) — The component type that this mass distribution represents.
[massType] (default var_str('unknown')) — The mass type that this mass distribution represents.
[nonAnalyticSolver] (default var_str('fallThrough')) — Selects how solutions are computed when no analytic solution is available. If set to “fallThrough” then the solution ignoring heating is used, while if set to “numerical” then numerical solvers are used to find solutions.
[componentType] (default var_str('unknown')) — The component type that this mass distribution represents.
[massType] (default var_str('unknown')) — The mass type that this mass distribution represents.
[tolerateVelocityMaximumFailure] (default .false.) — If true, tolerate failures to find the radius of the peak in the rotation curve.
[tolerateEnclosedMassIntegrationFailure] (default .false.) — If true, tolerate failures to find the mass enclosed as a function of radius.
[toleratePotentialIntegrationFailure] (default .false.) — If true, tolerate failures to compute the potential.
[fractionRadiusFinalSmall] (default 1.0d-3) — The initial radius is limited to be no smaller than this fraction of the final radius. This can help avoid problems in profiles that are extremely close to being disrupted.
[toleranceRelativePotential] (default 1.0d-3) — The maximum allowed relative tolerance to use in numerical solutions for the gravitational potential in dark-matter-only density profiles before aborting.
[lengthResolution] — The spatial resolution length scale (in Mpc) below which the underlying density profile is softened to a flat core, mimicking the finite force resolution of an N-body simulation.
[nonAnalyticSolver] (default var_str('fallThrough')) — Selects how solutions are computed when no analytic solution is available. If set to “fallThrough” then the solution ignoring heating is used, while if set to “numerical” then numerical solvers are used to find solutions.
[componentType] (default var_str('unknown')) — The component type that this mass distribution represents.
[massType] (default var_str('unknown')) — The mass type that this mass distribution represents.
[massMinimum] — The minimum halo mass (in \(\mathrm{M}_\odot\)) below which halos are excluded from the mass function histogram.
[massMaximum] — The maximum halo mass (in \(\mathrm{M}_\odot\)) above which halos are excluded from the mass function histogram.
[massCountPerDecade] — The number of logarithmic bins per decade of halo mass used when constructing the halo mass function.
[description] — A human-readable description of this mass function dataset, stored as metadata in the output file.
[simulationReference] — A bibliographic reference for the N-body simulation from which this mass function is derived, stored as metadata.
[simulationURL] — A URL pointing to the publicly accessible dataset or documentation for the N-body simulation, stored as metadata.
[bootstrapSampleCount] (default 30_c_size_t) — The number of bootstrap resamples of the particles that should be used.
[representativeMinimumCount] (default 10_c_size_t) — Minimum number of representative particles used to compute the center of a halo.
[tolerance] (default 1.0d-2) — The tolerance in the summed weight of bound particles which must be attained to declare convergence.
[bootstrapSampleRate] (default 1.0d0) — The sampling rate for particles.
[representativeFraction] (default 0.05d0) — Fraction of bound particles used to compute the center of a halo.
[analyzeAllParticles] (default .true.) — If true, all particles are assumed to be self-bound at the beginning of the analysis. Unbound particles at previous times are allowed to become bound in the current snapshot. If false and the self-bound information from the previous snapshot is available, only the particles that are self-bound at the previous snapshot are assumed to be bound at the beginning of the analysis.
[useVelocityMostBound] (default .false.) — If true, the velocity of the most bound particle in velocity space is used as the representative velocity of the satellite. If false, use the mass weighted mean velocity (center-of-mass velocity) of self-bound particles instead.
[orderRotation] (default var_str('none')) — The order in which evaluation of likelihoods should be rotated as a function of process number.
[logLikelihoodAccept] (default huge(0.0d0)) — The log-likelihood which should be “accepted”—once the log-likelihood reaches this value (or larger) no further updates to the chain will be made.
[report] (default .false.) — If true, report on the log-likelihood obtained.
[means] — The mean of the multivariate normal distribution.
[covariance] — The covariance matrix for the of the multivariate normal distribution.
[countForestsMaximum] (default -1_c_size_t) — If set to a positive number, this is the maximum number of forests that will be evolved.
[walltimeMaximum] (default -1_kind_int8) — If set to a positive number, this is the maximum wall time for which forest evolution is allowed to proceed before the task gives up.
[tolerateFailures] (default .false.) — If true then failures to evolve a forest are tolerated. The forest is evolved no further, but evolution of other forests continues.
[evolveForestsInParallel] (default .true.) — If true then each forest is evolved by a separate OpenMP thread. Otherwise, a single thread evolves all forests.
[suspendToRAM] (default .true.) — Specifies whether trees should be suspended to RAM (otherwise they are suspend to file).
[suspendPath] — The path to which tree suspension files will be stored.
[timeIntervalCheckpoint] (default -1_kind_int8) — If positive, gives the time in seconds between storing of checkpoint files. If zero or negative, no checkpointing is performed..
[fileNameCheckpoint] — The path to which checkpoint data will be stored.
[logM0] (default 10.0d0) — The parameter \(\log_{10} M_0\) (with \(M_0\) in units of \(\mathrm{M}_\odot\)) appearing in the star formation rate threshold expression for the star formation rate galactic filter class.
[logSFR0] (default 9.0d0) — The parameter \(\alpha_0\) appearing in the star formation rate threshold expression for the star formation rate galactic filter class.
[logSFR1] (default 0.0d0) — The parameter \(\alpha_1\) appearing in the star formation rate threshold expression for the star formation rate galactic filter class.
[cW] (default 3.78062835d0) — The parameter \(c_\mathrm{W}\) in the Bohr et al. (2021) power spectrum window function.
[beta] (default 3.4638743d0) — The parameter \(\beta\) in the Bohr et al. (2021) power spectrum window function.
[transferFunctionType] (default var_str('darkMatter')) — Specifies whether to use the darkMatter or total transfer function.
[fileName] — The name of the file from which to read a tabulated transfer function.
[redshift] (default 0.0d0) — The redshift of the transfer function to read.
[factorWavenumberSmoothExtrapolation] (default 0.0d0) — If positive, and extrapolation is used at high wavenumbers, the slope for extrapolation will be set by averaging over wavenumbers from \(k_\mathrm{max}/f\) to \(k_\mathrm{max}\), where \(f=\)[factorWavenumberSmoothExtrapolation] and \(k_\mathrm{max}\) is the highest wavenumber tabulated. This avoids spurious extrapolation for highly oscillatory transfer functions.
[acceptNegativeValues] (default .false.) — If true, negative values in the transfer function are allowed (and the absolute value is taken prior to interpolation). Otherwise, negative values result in an error.
[fractionalTimeStep] (default 0.01d0) — The fractional time step used when computing barrier crossing rates (i.e. the step used in finite difference calculations).
[fileName] (default var_str('none')) — The name of the file to/from which tabulations of barrier first crossing probabilities should be written/read. If set to “none” tables will not be stored.
[fractionalTimeStep] (default 0.01d0) — The fractional time step used when computing barrier crossing rates (i.e. the step used in finite difference calculations).
[varianceNumberPerUnitProbability] (default 1000) — The number of points to tabulate per unit variance for first crossing probabilities.
[varianceNumberPerUnit] (default 40) — The number of tabulation points per unit of \(\sigma^2\) used when building the rate look-up table for the Farahi excursion-set first-crossing distribution; higher values improve interpolation accuracy at the cost of memory and initialization time.
[varianceNumberPerDecade] (default 400) — The number of points to tabulate per decade of progenitor variance for first crossing rates.
[varianceNumberPerDecadeNonCrossing] (default 40) — The number of points to tabulate per decade of progenitor variance for non-crossing rates.
[timeNumberPerDecade] (default 10) — The number of tabulation points per decade of cosmic time used when building the first-crossing rate look-up table as a function of time; higher values improve temporal interpolation accuracy for rapidly evolving cosmologies.
[varianceIsUnlimited] (default .false.) — If true, the variance is assumed to have no upper limit (e.g. as in the case of CDM). This allows the tabulated solutions to be extended arbitrarily. Otherwise, tables are extended to encompass just the range of variance requested.
[linkingLength] (default 0.2d0) — The friends-of-friends linking length to use in computing virial density contrasts with the percolation analysis of More et al. (2011).

`taskExcursionSets`¶

A task which computes and outputs excursion set statistics over a grid of halo masses and cosmic times, including the variance of the density field, the excursion set barrier, the first-crossing probability and rate, the halo mass function, and the matter power spectrum. These quantities characterize the stochastic evolution of density perturbations in the extended Press-Schechter formalism.

Parameters

[massMinimum] (default 1.0d10) — The minimum mass at which to tabulate excursion set solutions.
[massMaximum] (default 1.0d15) — The maximum mass at which to tabulate excursion set solutions.
[massesPerDecade] (default 10) — The number of points per decade of mass at which to tabulate excursion set solutions.
[redshiftMinimum] (default 0.0d0) — The minimum redshift at which to tabulate excursion set solutions.
[redshiftMaximum] (default 10.0d0) — The maximum redshift at which to tabulate excursion set solutions.
[timesPerDecade] (default 10) — The number of points per decade of time at which to tabulate excursion set solutions.
[outputGroup] (default var_str('excursionSets')) — The HDF5 output group within which to write excursion set solution data.

`taskHaloMassFunction`¶

A task which computes and outputs the differential halo mass function \(\mathrm{d}n/\mathrm{d}\log M\) and related quantities—including halo bias, concentration, scale radius, dark matter profile, virial density contrasts, and unevolved subhalo mass function—over a grid of halo masses and output times.

Methods

descriptorSpecial — Handle adding special parameters to the descriptor.

Parameters

[abundanceMinimum] (default -1.0d0) — The abundance (in units of Mpc\(^{-3}\)) below which to truncate the halo mass function when sampling halo masses for tree construction. A negative value indicates no truncation.
[abundanceMaximum] (default -1.0d0) — The abundance (in units of Mpc\(^{-3}\)) above which to truncate the halo mass function when sampling halo masses for tree construction. A negative value indicates no truncation.
[modifier1] (default 0.0d0) — Coefficient of the polynomial modifier applied to the halo mass function when sampling halo masses for tree construction.
[modifier2] (default 0.0d0) — Coefficient of the polynomial modifier applied to the halo mass function when sampling halo masses for tree construction.
[baseParametersFileName] — The path to the XML parameter file that provides the base configuration for each model evaluation, to which parameter changes from the posterior sampler are then applied.
[pathSamples] (default var_str('none')) — The path into which the sampled mass functions should be written. If none, then samples are not written.
[appendSamples] (default .false.) — If true, samples will be appended to the file. Otherwise, the file is overwritten.
[fileNames] — The names of the files containing the halo mass functions.
[redshifts] — The redshifts at which to evaluate the halo mass functions.
[massRangeMinimum] — The minimum halo mass to include in the likelihood evaluation.
[massRangeMaximum] (default huge(0.0d0)) — The maximum halo mass to include in the likelihood evaluation.
[binCountMinimum] — The minimum number of halos per bin required to permit bin to be included in likelihood evaluation.
[likelihoodPoisson] (default .false.) — If true, likelihood is computed assuming a Poisson distribution for the number of halos in each bin (with no covariance between bins). Otherwise a multivariate normal is assumed when computing likelihood.
[varianceFractionalModelDiscrepancy] (default 0.0d0) — The fractional variance due to model discrepancy.
[allowEmptyMassFunction] (default .false.) — If true, empty mass functions (i.e. those with no useable bins) are allowed, and return \(\log \mathcal{L}=0\).
[report] (default .false.) — If true, give detailed reporting on likelihood calculations.
[includeCorrelations] (default .false.) — If true, account for correlations between halo mass functions measured at different redshifts.
[binAverage] (default .true.) — If true, the mass function is averaged over each bin.
[changeParametersFileNames] — The names of files containing parameter changes to be applied.
[haloMassMinimum] (default 1.0d10) — The minimum mass at which to tabulate halo mass functions.
[haloMassMaximum] (default 1.0d15) — The maximum mass at which to tabulate halo mass functions.
[pointsPerDecade] (default 10.0d0) — The number of points per decade of halo mass at which to tabulate halo mass functions.
[outputGroup] (default var_str('.')) — The HDF5 output group within which to write mass function data.
[includeUnevolvedSubhaloMassFunction] (default .false.) — If true then also compute and output the unevolved subhalo mass function.
[includeMassAccretionRate] (default .true.) — If true then also compute and output the mass accretion rate of the halos.
[massesRelativeToHalfModeMass] (default .false.) — If true then masses are interpreted (and output) relative to the half-mode mass. (If the half-mode mass is undefined an error will occur.) If false, masses are absolute.
[errorsAreFatal] (default .true.) — If true then errors in evaluating the halo mass function are considered to be fatal.
[labels] — Labels for virial density contrast mass definitions.
[fractionModeMasses] — List of suppression fractions at which to compute the fractional mode mass.

`taskHaloModelGenerate`¶

A task which populates a dark matter halo catalog with galaxies using a halo occupation distribution (HOD) model, placing central and satellite galaxies within each halo according to the conditional stellar mass function and dark matter profile, producing a mock galaxy catalog with positions for use in clustering analyses.

Parameters

[haloCatalogFileName] — The file name of the halo catalog to populate.
[galaxyCatalogFileName] — The file name to which the galaxy catalog should be output.
[massMinimum] — The minimum mass galaxy to include in a mock halo model realization.
[massMaximum] (default 1.0d16) — The maximum mass galaxy to include in a mock halo model realization.

`taskHaloModelProjectedCorrelationFunction`¶

A task which analytically computes the projected two-point correlation function \(w_\mathrm{p}(r_\mathrm{p})\) using a halo occupation distribution (HOD) model, combining the one-halo term (galaxy pairs within the same halo, sourced from the dark matter profile) and the two-halo term (pairs in different halos, sourced from the linear power spectrum and halo bias), then convolves with the survey geometry and line-of-sight integral depth.

Parameters

[haloMassMinimum] — The minimum halo mass over which to integrate.
[haloMassMaximum] — The maximum halo mass over which to integrate.
[lineOfSightDepth] — The line of sight depth over which to integrate.
[halfIntegral] — If true, integrate only over positive line of sight depths.
[fileName] — The name of the file containing the target projected correlation function.
[separationMinimum] — The minimum separation at which to compute the projected correlation function.
[separationMaximum] — The maximum separation at which to compute the projected correlation function.
[countSeparations] — The number of separations at which to compute the projected correlation function.
[depthLineOfSight] — The maximum line of sight depth to which to integrate when computing the projected correlation function.
[halfIntegral] (default .false.) — Set to true if the projected correlation function is computed as \(w_\mathrm{p}(r_\mathrm{p})=\int_0^{+\pi_\mathrm{max}} \xi(r_\mathrm{p},\pi) \mathrm{d} \pi\), instead of the usual \(w_\mathrm{p}(r_\mathrm{p})=\int_{-\pi_\mathrm{max}}^{+\pi_\mathrm{max}} \xi(r_\mathrm{p},\pi) \mathrm{d} \pi\).
[massMinimum] (default 1.0d8) — The minimum mass of galaxies to include in the projected correlation function calculation.
[massMaximum] (default 1.0d12) — The maximum mass of galaxies to include in the projected correlation function calculation.
[massHaloMinimum] (default 1.0d6) — The minimum halo mass to use when integrating over the halo mass function.
[massHaloMaximum] (default 1.0d16) — The maximum halo mass to use when integrating over the halo mass function.
[outputGroup] (default var_str('projectedCorrelationFunction')) — The HDF5 output group within which to write the projected correlation function.

`taskHaloSpinDistribution`¶

A task which computes and outputs the differential distribution of dark matter halo spin parameters \(\mathrm{d}P/\mathrm{d}\lambda\) over a specified range of spin values at each output time, for halos above a specified minimum mass.

Parameters

[spinMinimum] (default 3.0d-4) — Minimum spin for which the distribution function should be calculated.
[spinMaximum] (default 0.5d0) — Maximum spin for which the distribution function should be calculated.
[spinPointsPerDecade] (default 10.0d0) — Number of points per decade of spin at which to calculate the distribution.
[haloMassMinimum] (default 0.0d0) — Minimum halo mass above which spin distribution should be averaged.
[outputGroup] (default var_str('.')) — The HDF5 output group within which to write spin distribution data.

`taskIntergalacticMediumState`¶

A task which computes and outputs the thermal and ionization state of the intergalactic medium (IGM) at each output time, including the IGM temperature, neutral fraction, and Jeans filtering mass that regulates gas accretion onto low-mass halos.

Parameters

[outputGroup] (default var_str('.')) — The HDF5 output group within which to write intergalactic medium state data.

`taskLocalGroupDatabase`¶

A task which updates the Local Group database, downloading and processing observational data on Local Group galaxies (such as stellar masses, star formation rates, and structural parameters) for use as constraints in galaxy formation models.

Methods

operator(==) — Test equality of two 3D vectors.
operator(<) — Less than operator for two 3D vectors.
operator(>) — Greater than operator for two 3D vectors.
getProperty — Return an array of values of the named property for the current selection.
select — Select all galaxies in the current selection where the named property has the given value.
selectAll — Select all galaxies in the database.
update — Update the database.

`taskMassFunctionCovariance`¶

A task class which computes and stores covariance matrices for mass functions. In general, for constraints corresponding to mass functions (whether stellar mass or HI mass), the covariance matrix of the observational data is determined using the analytic model of Smith (2012). This requires knowledge of both the survey geometry (angular mask and radial extent as a function of mass) and of the HOD of the observed galaxies.

Details of the survey geometry and depth are given for each individual constraints. Computing the large-scale structure contribution to the covariance function requires integration of the non-linear matter power spectrum over the Fourier transform of the survey window function. We use the method of Peacock and Dodds (1996) to determine the non-linear matter power spectrum, because of its simplicity and speed. We have checked that using a more accurate non-linear matter power spectrum (e.g. Lawrence et al. 2010) makes negligible difference to our results. If the angular power spectrum of the survey mask is availablefootnoteTypically if the survey geometry is defined by mangle polygons, allowing the angular power spectrum to be found using the mangle harmonize utility., this is used to compute the relation

\[\sigma^2(M_\mu,M_\nu) = {2 \over \pi V_\mu V_\nu}\int_0^\infty \mathrm{d} k\, k^{-4} P(k) \sum_i \sum_j \sum_{\ell=0}^\infty (2\ell+1) C^{ij}_\ell R^i_{\ell}(kr_{\mu 0},kr_{\mu 1}) R^j_{\ell}(kr_{\nu 0},kr_{\nu 1}),\]

where \((2\ell+1) C^{ij}_\ell = \sum_{m=-\ell}^{+\ell} \Psi^i_{\ell m} \Psi^{j*}_{\ell m}\), \(\Psi^i_{\ell m}\) are the spherical harmonic coefficients of the \(i^\mathrm{th}\) field of the survey, \(V\) is the maximum distance to which a galaxy of mass \(M\) can be seen, \(P(k)\) is the nonlinear power spectrum and

\[R_{\ell}(x_0,x_1) \equiv \int_{x_0}^{x_1} x^2 j_\ell(x) \mathrm{d}x = \sqrt{\pi} 2^{-2-\ell} \Gamma\left({1\over 2}[3+\ell]\right) \left[ x^{3+\ell} \tensor*[_1]{\stackrel{\sim}{F}}{_2} \left({1\over 2}[3+\ell]; \ell+{3\over 2},{1\over 2}(5+\ell);-{x^2\over 4}\right)\right]_{x_0}^{x_1},\]

where \(\tensor*[_1]{\stackrel{\sim}{F}}{_2}\) is the regularized generalized hypergeometric function. In other cases, where the angular power spectrum is not available, the survey geometry is realized on a grid which is when Fourier transformed to obtain the appropriate window function.

To find a suitable HOD to describe the observed galaxies we adopt the model of Behroozi et al. (2010). This is an 11 parameter model which describes separately the numbers of satellite and central galaxies occupying a halo of given mass—the reader is referred to Behroozi et al. (2010) for a complete description of the functional form of this parametric HOD. An MCMC approach is used to to constrain the HOD parameters to fit the observational data. We use a likelihood

\[\ln \mathcal{L} = -{1\over 2} \Delta\cdot \mathcal{C}^{-1}\cdot \Delta^\mathrm{T} - {N \over 2} \ln(2\pi) - {\ln |\mathcal{C}| \over 2},\]

where \(N\) is the number of bins in the mass function, \(\mathcal{C}\) is the covariance matrix of the observed mass function, and \(\Delta_i = \phi_i^\mathrm{(HOD)} - \phi_i^\mathrm{(observed)}\). Of course, it is precisely this covariance matrix, \(\mathcal{C}\), that we are trying to compute. We therefore adopt an iterative approach as follows:

make an initial estimate of the covariance matrix, assuming that only Poisson errors contribute (the covariance matrix is therefore diagonal, and the terms are easily computed from the measured mass function and the survey volume as a function of stellar mass);
find the maximum likelihood parameters of the HOD given the observed mass function and the current estimate of the covariance matrix;
using this HOD and the framework of Smith (2012), compute a new estimate of the covariance matrix, including all three contributions;
repeat steps 2 and 3 until convergence in the covariance matrix is achieved.

In practice we find that this procedure often leads to an HOD and covariance matrix which oscillate between two states in successive iterations. The differences in the covariance matrix are relatively small however, so we choose to conservatively adopt the covariance matrix with the larger values.

Parameters

[massFunctionFileName] — The name of the file to which the covariance matrix should be written.
[surveyRedshiftMinimum] (default 0.0d0) — The minimum redshift at which calculations of the mass function covariance should be carried out.
[surveyRedshiftMaximum] (default 0.1d0) — The maximum redshift at which calculations of the mass function covariance should be carried out.
[countMassBins] (default 10) — The number of bins in the mass function for covariance calculations.
[massMinimum] (default 1.0d08) — The minimum mass in the mass function for covariance calculations.
[massMaximum] (default 1.0d13) — The maximum mass in the mass function for covariance calculations.
[includePoisson] (default .true.) — Specifies whether or not to include the Poisson contribution to mass function covariance matrices.
[includeHalo] (default .true.) — Specifies whether or not to include the halo contribution to mass function covariance matrices.
[includeLSS] (default .true.) — Specifies whether or not to include the large-scale structure contribution to mass function covariance matrices.
[massHaloMinimum] (default 1.0d10) — The minimum halo mass to use when computing mass function covariance matrices.
[massHaloMaximum] (default 1.0d15) — The minimum halo mass to use when computing mass function covariance matrices.
[sizeGridFFT] (default 64) — The size of the FFT grid to use in computing window functions for mass function covariance matrices.

`taskMergerTreeFileBuilder`¶

This task will build a merger tree file in the format described here from merger tree descriptions in other formats, such as ASCII output from an SQL database. An example of how the builder can be used can be found in this tutorial.

The builder is flexible, and therefore requires many parameters to control how it processes input files, all of which are described below.

The builder reads from an ASCII file containing one halo per line. The [property] sub-parameters allow specification of which properties are present in the file, and in which column. The builder can optionally also read a file of associated particle data—this can be used to assign positions to orphan halos if desired.

The merger tree file builder can currently export in one of two formats:

galacticus: merger trees are exported in Galacticus’s native format described in detail here;
irate: merger trees are exported in the IRATE format.

Properties to read from the file are specified through multiple property sub-parameter sections, which take the form:

<property>
 <name             value="propertyName"/>
 <column           value="columnNumber"/>
 <conversionFactor value="1.0e0"       />
</property>

where [name] is the property name (see below), [column] is the column number (starting from 1) from which to read the property, and the optional [conversionFactor] specifies an additional factor by which the property should be multiplied to place it into the correct internal units for GalacticusfootnoteThe units for masses, lengths, and velocities in the input file are specified in their own parameter sub-sections. Conversion from these units to Galacticus’s internal units is performed automatically. However, sometimes the input data may have inconsistent units between columns (e.g. positions in units of Mpc, but scale radii in units of kpc). In such cases this additional conversion factor can be applied to bring all quantities into a consistent unit system..

Recognized property names are

treeIndex: A unique ID number for the tree to which this node belongs;
nodeIndex: An ID (unique within the tree) for this node;
descendantIndex: The ID of the node’s descendant node;
hostIndex: The ID of the larger halo in which this node is hosted (equal to the node’s own ID if the node is self-hosting);
redshift: The redshift of the node;
nodeMass: The mass of the node;
particleCount: The number of particles in the node;
positionX: The \(x\)-position of the node (if present, both \(y\) and \(z\) components must also be present);
positionY: The \(y\)-position of the node (if present, both \(x\) and \(z\) components must also be present);
positionZ: The \(z\)-position of the node (if present, both \(x\) and \(y\) components must also be present);
velocityX: The \(x\)-velocity of the node (if present, both \(y\) and \(z\) components must also be present);
velocityY: The \(y\)-velocity of the node (if present, both \(x\) and \(z\) components must also be present);
velocityZ: The \(z\)-velocity of the node (if present, both \(x\) and \(y\) components must also be present);
spinX: The \(x\) component of the node’s spin parameter (if present, both \(y\) and \(z\) components must also be present; cannot be present if spin magnitude is given);
spinY: The \(y\) component of the node’s spin parameter (if present, both \(x\) and \(z\) components must also be present; cannot be present if spin magnitude is given);
spinZ: The \(z\) component of the node’s spin parameter (if present, both \(x\) and \(y\) components must also be present; cannot be present if spin magnitude is given);
spin: The magnitude of the node’s spin parameter (cannot be present if spin vector components are given);
angularMomentumX: The \(x\)-component of the node’s angular momentum (if present, both \(y\) and \(z\) components must also be present; cannot be present if angular momentum magnitude is given);
angularMomentumY: The \(y\)-component of the node’s angular momentum (if present, both \(x\) and \(z\) components must also be present; cannot be present if angular momentum magnitude is given);
angularMomentumZ: The \(z\)-component of the node’s angular momentum (if present, both \(x\) and \(y\) components must also be present; cannot be present if angular momentum magnitude is given);
angularMomentum: The magnitude of the node’s angular momentum (cannot be present if angular momentum vector components are given);
halfMassRadius: The half-mass radius of the node;
mostBoundParticleIndex: The index of the most bound particle in this node.

Not all properties must be specified—any required properties that are not specified will result in an error. Likewise, some properties, if present, require that other properties also be present. For example, if any of the position properties is given then all three positions are required.

Properties of particles to read from the (optional) particle data file are specified through multiple particleProperty sub-parameter sections, which take the form:

<particleProperty>
 <name   value="propertyName"/>
 <column value="columnNumber"/>
</particleProperty>

where [name] is the particle property name (see below), [column] is the column number (starting from 1) from which to read the particle property.

Recognized particle property names are

particleIndex: A unique ID for the particle;
redshift: The redshift of the particle;
nodeMass: The mass of the particle;
particleCount: The number of particles in the particle;
positionX: The \(x\)-position of the particle (if present, both \(y\) and \(z\) components must also be present);
positionY: The \(y\)-position of the particle (if present, both \(x\) and \(z\) components must also be present);
positionZ: The \(z\)-position of the particle (if present, both \(x\) and \(y\) components must also be present);
velocityX: The \(x\)-velocity of the particle (if present, both \(y\) and \(z\) components must also be present);
velocityY: The \(y\)-velocity of the particle (if present, both \(x\) and \(z\) components must also be present);
velocityZ: The \(z\)-velocity of the particle (if present, both \(x\) and \(y\) components must also be present).

The units used in the files are specified via the unitsMass, unitsLength, and unitsVelocity sub-parameter sections. These have the following form:

<unitsMass>
 <name                value="Solar masses/h"/>
 <unitsInSI           value="1.99e30"       />
 <hubbleExponent      value="-1"            />
 <scaleFactorExponent value=" 0"            />
</unitsMass>

where [name] is a human-readable name for the units, [unitsInSI] gives the units in the SI system, [hubbleExponent] specifies the power to which \(h\) appears in the units and [scaleFactorExponent] specifies the number of powers of the expansion factor by which the quantity should be multiplied to place it into physical units.

Finally, arbitrary metadata can be added to the file (which can be useful to record, for example, the origin of the data, or details of the simulation, or halo finder used). Metadata is specified via metaData sub-parameter sections. These have the following form:

<metaData>
 <name    value="simulationCode"/>
 <content value="Gadget2"       />
 <type    value="simulation"    />
</metaData>

where [name] is a name for this metadatum, [content] is the value for the metadatum (integer, floating point, and text content is allowed), and [type] specifies the type of metadatum, and must be one of:

generic: Add to the generic metaData group;
cosmology: Add to the cosmology group;
simulation: Add to the simulation group;
groupFinder: Add to the groupFinder group;
treeBuilder: Add to the treeBuilder group;
provenance: Add to the provenance group.

Methods

descriptorSpecial — Handle adding special parameters to the descriptor.

Parameters

[inputFileName] — The name of the file from which to read merger tree data.
[particlesFileName] — The name of the file from which to read particle data.
[outputFileName] — The name of the file to which to write merger tree data.
[outputFormat] — The format to use for merger tree output.
[columnHeaders] (default .false.) — If true, the file is assumed to contain a single line of column headers, which will be skipped.
[columnSeparator] (default var_str(',')) — The separator for columns.
[massParticle] — The mass of the simulation particle.
[dummyHostId] — If present, specifies the dummy host ID for self-hosting halos. Otherwise, self-hosting halos have hostIndex == nodeIndex.
[haloMassesIncludeSubhalos] — Specifies whether or not halo masses include the masses of their subhalos.
[includesHubbleFlow] — Specifies whether or not Hubble flow is included in velocities.
[positionsArePeriodic] — Specifies whether or not positions are periodic.
[name] — The name of the property to read.
[column] — The column from which to read the property.
[conversionFactor] — An additional conversion factor to apply to the property to get it into the correct units.
[name] — The name of the particle property to read.
[column] — The column from which to read the particle property.
[name] — The name of the metadata.
[content] — The value of the metadata.
[type] — The metadata type.
[unitsInSI] — The mass unit in the SI system.
[hubbleExponent] — The exponent of the “little-\(h\)” Hubble parameter needed to convert the masses to little-\(h\)-free units.
[scaleFactorExponent] — The exponent of the cosmological scale factor needed to convert the masses to physical units.
[name] — A human-readable name for the units of mass.
[unitsInSI] — The length unit in the SI system.
[hubbleExponent] — The exponent of the “little-\(h\)” Hubble parameter needed to convert the lengths to little-\(h\)-free units.
[scaleFactorExponent] — The exponent of the cosmological scale factor needed to convert the lengths to physical units.
[name] — A human-readable name for the units of length.
[unitsInSI] — The velocity unit in the SI system.
[hubbleExponent] — The exponent of the “little-\(h\)” Hubble parameter needed to convert the velocities to little-\(h\)-free units.
[scaleFactorExponent] — The exponent of the cosmological scale factor needed to convert the velocities to physical units.
[name] — A human-readable name for the units of velocity.

`taskMergingHaloOrbitDistribution`¶

A task which tabulates the joint distribution of orbital parameters (velocity at virial radius and tangential-to-total velocity ratio) for halos merging into host halos, sampled from the virial orbit model weighted by the merger tree branching probability and halo mass function, and outputs the resulting distribution for analysis.

Parameters

[velocityMinimum] — The minimum velocity (in units of the host virial velocity) for which to compute velocity distributions.
[velocityMaximum] — The maximum velocity (in units of the host virial velocity) for which to compute velocity distributions.
[countVelocitiesPerUnit] — The number of points per unit of velocity (in units of the host virial velocity) for which to compute velocity distributions.
[massMinimum] — The minimum mass halo for which to compute mergingHaloOrbitDistribution properties.
[massMaximum] — The maximum mass halo for which to compute mergingHaloOrbitDistribution properties.
[countMassesPerDecade] — The number of points per decade of mass for which to compute mergingHaloOrbitDistribution properties.
[redshift] — The redshift.

`taskMulti`¶

A task which sequentially performs multiple other tasks, iterating through a linked list of taskClass objects and calling each one’s perform method in order. This allows combining several independent computations (e.g., evolving forests plus computing a power spectrum) into a single Galacticus run.

Methods

columnDescriptions — Return a description of the columns.
elementCount — Return the number of properties in the tuple.
extractDouble — Extract the double properties from the given node.
extractInteger — Extract the integer properties from the given node.
names — Return the names of the properties extracted.
descriptions — Return descriptions of the properties extracted.
unitsInSI — Return the units of the properties extracted in the SI system.
units — Return an object containing units metadata for the properties.
ranks — Return the ranks of the properties extracted.
metaData — Populate a hash with meta-data for the property.

`taskNBodyAnalyze`¶

A task which imports particle or halo data from an N-body simulation using a configurable importer, applies a chain of operators (e.g., computing density profiles, identifying substructure, computing statistics), and optionally writes the processed data back to the imported format.

Parameters

[storeBackToImported] (default .true.) — If true, computed properties and results will be stored back to the file from which a simulation was imported (assuming it is of HDF5 type).

`taskPosteriorSample`¶

A task which performs Bayesian inference by sampling from the posterior distribution of model parameters given observational constraints. Delegates to a posteriorSampleSimulationClass object that implements the specific sampling algorithm (e.g., MCMC, differential evolution, or particle swarm optimization).

Parameters

[initializeNodeClassHierarchy] (default .true.) — If true then initialize the node class hierarchy in the posterior sampling class. This should be set to false if the likelihood function will instead perform this action.

`taskPostprocessForests`¶

A task which postprocesses galaxies within a set of merger tree forests. This task assumes that a prior model was run, with raw forest data written to file using the mergerTreeOutputterFullState merger tree outputter class. The name of that file is specified via the fileName parameter. Forests data will be re-read, and re-output. Note that you should use the exact same parameter file (other than changing the task, and possibly removing the use of the mergerTreeOutputterFullState outputter) as was used to run the original model. This ensures that the raw data structures read from the file follow the same format as was used to write them. Also note that forests are not guaranteed to be output in the same order as in the original model if OpenMP parallelism is used. If the same order is required, it is recommend to run the postprocessing after setting the environment variable OMP_NUM_THREADS=1.

Parameters

[fileName] — The name of the file from which forests should be read.

`taskPowerSpectra`¶

A task which computes and outputs the power spectrum and related quantities.

Parameters

[pointsPerUnit] — The number of points per unit wavenumber at which to tabulate power spectra.
[pointsPerDecade] (default 10.0d0) — The number of points per decade of wavenumber at which to tabulate power spectra.
[wavenumberMinimum] (default 1.0d-3) — The minimum wavenumber at which to tabulate power spectra.
[wavenumberMaximum] (default 1.0d+3) — The maximum wavenumber at which to tabulate power spectra.
[includeNonLinear] (default .false.) — If true the nonlinear power spectrum is also computed and output.
[massSmoothingWindowFunction] (default -1.0d0) — If positive, the window function evaluated at this smoothing mass will be output.
[outputGroup] (default var_str('.')) — The HDF5 output group within which to write power spectrum data.

`taskRadiativeTransfer`¶

A task which performs radiative transfer.

Parameters

[wavelengthMinimum] (default 0.3d4) — The minimum wavelength at which to sample photon packets.
[wavelengthMaximum] (default 10.0d4) — The maximum wavelength at which to sample photon packets.
[wavelengthCountPerDecade] (default 10) — The number of wavelengths per decade at which to sample photon packets.
[countPhotonsPerWavelength] (default 10_c_size_t) — The number of photon packets to generate at each wavelength.
[countPhotonsPerWavelengthFinalIteration] (default countPhotonsPerWavelength) — The number of photon packets to generate at each wavelength on the final iteration.
[countIterationsMinimum] (default 1_c_size_t) — The minimum number of iterations.
[countIterationsMaximum] (default 10_c_size_t) — The maximum number of iterations.
[outputGroupName] (default var_str('radiativeTransferModel')) — The name of the group to which results should be output.
[outputIterations] (default .false.) — If true, output data for all iterations, not just the final iteration.

`taskReport`¶

A task which reports on version and build information.

`taskVelocityField`¶

A task which computes and outputs the cosmological velocity field.

Parameters

[massMinimum] (default 1.0d10) — The minimum mass scale at which to tabulate the velocity field.
[massMaximum] (default 1.0d+3) — The maximum mass scale at which to tabulate the velocity field.
[pointsPerDecade] (default 10) — The number of points per decade of mass at which to tabulate the velocity field.
[outputGroup] (default var_str('.')) — The HDF5 output group within which to write velocity field data.

Tasks¶

Methods¶

taskAGNSpectraHopkins2008BuildFile¶

taskBuildBroadbandLuminosityTabulations¶

taskBuildSEDTabulations¶

taskBuildTableCIECloudy¶

taskBuildToolAxionCAMB¶

taskBuildToolCAMB¶

taskBuildToolCLASS¶

taskBuildToolCloudy¶

taskBuildToolFSPS¶

taskBuildToolMangle¶

taskBuildToolRecFast¶

taskCatalogProjectedCorrelationFunction¶

taskComovingDistances¶

taskConditionalMassFunction¶

taskEvolveForests¶

taskExcursionSets¶

taskHaloMassFunction¶

taskHaloModelGenerate¶

taskHaloModelProjectedCorrelationFunction¶

taskHaloSpinDistribution¶

taskIntergalacticMediumState¶

taskLocalGroupDatabase¶

taskMassFunctionCovariance¶

taskMergerTreeFileBuilder¶

taskMergingHaloOrbitDistribution¶

taskMulti¶

taskNBodyAnalyze¶

taskPosteriorSample¶

taskPostprocessForests¶

taskPowerSpectra¶

taskRadiativeTransfer¶

taskReport¶

taskVelocityField¶

`taskAGNSpectraHopkins2008BuildFile`¶

`taskBuildBroadbandLuminosityTabulations`¶

`taskBuildSEDTabulations`¶

`taskBuildTableCIECloudy`¶

`taskBuildToolAxionCAMB`¶

`taskBuildToolCAMB`¶

`taskBuildToolCLASS`¶

`taskBuildToolCloudy`¶

`taskBuildToolFSPS`¶

`taskBuildToolMangle`¶

`taskBuildToolRecFast`¶

`taskCatalogProjectedCorrelationFunction`¶

`taskComovingDistances`¶

`taskConditionalMassFunction`¶

`taskEvolveForests`¶

`taskExcursionSets`¶

`taskHaloMassFunction`¶

`taskHaloModelGenerate`¶

`taskHaloModelProjectedCorrelationFunction`¶

`taskHaloSpinDistribution`¶

`taskIntergalacticMediumState`¶

`taskLocalGroupDatabase`¶

`taskMassFunctionCovariance`¶

`taskMergerTreeFileBuilder`¶

`taskMergingHaloOrbitDistribution`¶

`taskMulti`¶

`taskNBodyAnalyze`¶

`taskPosteriorSample`¶

`taskPostprocessForests`¶

`taskPowerSpectra`¶

`taskRadiativeTransfer`¶

`taskReport`¶

`taskVelocityField`¶