Skip to content

Commit

Permalink
build based on 47a27d9
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jan 16, 2023
1 parent 016d1cd commit 813860e
Show file tree
Hide file tree
Showing 30 changed files with 18,982 additions and 2 deletions.
2 changes: 1 addition & 1 deletion stable
1 change: 1 addition & 0 deletions v0.6
11 changes: 11 additions & 0 deletions v0.6.0/BackgroundData/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Background Data · GaPSE.jl</title><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">GaPSE.jl</a></span></div><form class="docs-search" action="../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Introduction</a></li><li><span class="tocitem">The basic structure</span><ul><li class="is-active"><a class="tocitem" href>Background Data</a></li><li><a class="tocitem" href="../CosmoParams/">Cosmology Parameters</a></li><li><a class="tocitem" href="../Cosmology/">Cosmology Struct</a></li></ul></li><li><span class="tocitem">The window function F and its integration</span><ul><li><a class="tocitem" href="../WindowF/">Window F</a></li><li><a class="tocitem" href="../WindowFIntegrated/">Integrated Window F</a></li></ul></li><li><span class="tocitem">Calculating TPCFs multipoles</span><ul><li><a class="tocitem" href="../GNC_Correlations/">GNC</a></li><li><a class="tocitem" href="../LD_Correlations/">LD</a></li><li><a class="tocitem" href="../GNCxLD_Correlations/">GNCxLD</a></li><li><a class="tocitem" href="../GNCxLD_Correlations/">LDxGNC</a></li></ul></li><li><a class="tocitem" href="../PlaneParallelApprox/">Calculating TPCFs with the PP Approximation</a></li><li><a class="tocitem" href="../PowerSpectrum/">Calculating Power Spectra</a></li><li><a class="tocitem" href="../PNG/">implication on PNG</a></li><li><span class="tocitem">Utilities</span><ul><li><a class="tocitem" href="../Dicts/">Dictionaries and names</a></li><li><a class="tocitem" href="../MathUtils/">Mathematical Utilities</a></li><li><a class="tocitem" href="../CosmoUtils/">Cosmology Utilities</a></li><li><a class="tocitem" href="../IPSTools/">Input Power Spectrum Tools</a></li><li><a class="tocitem" href="../OtherUtils/">Other Utilities</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">The basic structure</a></li><li class="is-active"><a href>Background Data</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Background Data</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/cosmofico97/GaPSE/blob/main/docs/src/BackgroundData.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="Background-functions"><a class="docs-heading-anchor" href="#Background-functions">Background functions</a><a id="Background-functions-1"></a><a class="docs-heading-anchor-permalink" href="#Background-functions" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-binding" id="GaPSE.f0" href="#GaPSE.f0"><code>GaPSE.f0</code></a><span class="docstring-category">Constant</span></header><section><div><pre><code class="language-julia hljs"> const f0 :: Float64</code></pre><p>Linear growth rate at present time. Its value is equal to:</p><p class="math-container">\[ f_0 \simeq 0.5126998572951\]</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/cosmofico97/GaPSE/blob/47a27d99777f21253c79f9ff893b5ce53932a5d9/src/BackgroundData.jl#L20-L27">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="GaPSE.D0" href="#GaPSE.D0"><code>GaPSE.D0</code></a><span class="docstring-category">Constant</span></header><section><div><pre><code class="language-julia hljs"> const D0 :: Float64</code></pre><p>Linear growth factor at present time. Its value is equal to:</p><p class="math-container">\[ D_0 = 1.0\]</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/cosmofico97/GaPSE/blob/47a27d99777f21253c79f9ff893b5ce53932a5d9/src/BackgroundData.jl#L31-L38">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="GaPSE.ℋ0" href="#GaPSE.ℋ0"><code>GaPSE.ℋ0</code></a><span class="docstring-category">Constant</span></header><section><div><pre><code class="language-julia hljs"> const ℋ0 :: Float64</code></pre><p>Comoving Hubble constant at present time. Its value is, in natural system (where the speed of light c=1): <span>$\mathcal{H}_0 \simeq 3.335641\times10^{-4} \; h_0^{-1}\mathrm{Mpc}$</span></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/cosmofico97/GaPSE/blob/47a27d99777f21253c79f9ff893b5ce53932a5d9/src/BackgroundData.jl#L42-L48">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="GaPSE.BackgroundData" href="#GaPSE.BackgroundData"><code>GaPSE.BackgroundData</code></a><span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs"> BackgroundData(
z::Vector{Float64}
conftime::Vector{Float64}
comdist::Vector{Float64}
angdist::Vector{Float64}
lumdist::Vector{Float64}
D::Vector{Float64}
f::Vector{Float64}
ℋ::Vector{Float64}
ℋ_p::Vector{Float64})</code></pre><p>Struct that contains all the relevant cosmological information for future computations. The data are stored with increasing distance values (so the first ones are associated to <code>z=0</code>). It is internally used in <code>Cosmology.</code></p><p><strong>Arguments</strong></p><ul><li><p><code>z::Vector{Float64}</code> : redshifts (adimensionals).</p></li><li><p><code>conftime::Vector{Float64}</code> : conformal times, measured in [Mpc/h].</p></li><li><p><code>comdist::Vector{Float64}</code> : comoving distances, measured in [Mpc/h].</p></li><li><p><code>angdist::Vector{Float64}</code> : angular diameter distances, measured in [Mpc/h].</p></li><li><p><code>lumdist::Vector{Float64}</code> : luminosity distances, measured in [Mpc/h].</p></li><li><p><code>D::Vector{Float64}</code> : linear growth factors, normalized to 1.0 at the present day (adimensional).</p></li><li><p><code>f::Vector{Float64}</code> : linear growth rates (adimensional).</p></li><li><p><code>ℋ::Vector{Float64}</code> : comoving Hubble parameters, measured in [h/Mpc].</p></li><li><p><code>ℋ_p::Vector{Float64}</code> : derivatives of the comoving Hubble parameter wrt the conformal time. It is here manually computed with the Dierckx function <code>derivative</code>.</p></li></ul><p><strong>Constructors</strong></p><p><code>BackgroundData(file::String, z_max; names = NAMES_BACKGROUND, h = 0.7)</code></p><ul><li><p><code>file::string</code> : input file where the data are stored; it is expected that such file is a background output of the CLASS program (link: https://github.com/lesgourg/class_public)</p></li><li><p><code>z_max</code> : the maximum redhsift we are interested in our analysis. The constructor will store the data necessary for a study only in <code>0 &lt; z &lt; z_max</code>, for optimisation purposes (More precisely, the maximum distance stored will be <code>3*z_max</code>).</p></li><li><p><code>names = NAMES_BACKGROUND</code> : the column names of the <code>file</code>. If the colum order change from the default one <code>NAMES_BACKGROUND</code>, you must set as input the vector of string with the correct one, with the SAME names. They are, with the default order:</p><p><code>z , proper time [Gyr] , conf. time [Mpc] , H [1/Mpc] , comov. dist. , ang.diam.dist. , lum. dist. , comov.snd.hrz. , (.)rho_g , (.)rho_b , (.)rho_cdm , (.)rho_lambda , (.)rho_ur , (.)rho_crit , gr.fac. D , gr.fac. f ,</code></p></li><li><p><code>h = 0.7</code> : the adimensional hubble constant. By default, CLASS background data are measured with it numerically expressed (so distances are measured in <code>Mpc</code>, for example), while this code works with <code>h</code> in the unit of measure (so distances are measured in <code>Mpc/h</code>, for example). Change this value to <code>1.0</code> if the input data do not have this issue, or to your value of interest (<code>0.67</code>, <code>0.5</code>, ...).</p></li></ul><p>See also: <a href="../CosmoParams/#GaPSE.CosmoParams"><code>CosmoParams</code></a>, <a href="../Cosmology/#GaPSE.Cosmology"><code>Cosmology</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/cosmofico97/GaPSE/blob/47a27d99777f21253c79f9ff893b5ce53932a5d9/src/BackgroundData.jl#L56-L120">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Introduction</a><a class="docs-footer-nextpage" href="../CosmoParams/">Cosmology Parameters »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.23 on <span class="colophon-date" title="Monday 16 January 2023 15:54">Monday 16 January 2023</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 813860e

Please sign in to comment.