Skip to content

Commit 75cfdf9

Browse files
author
Documenter.jl
committed
build based on 1902953
1 parent b6cef37 commit 75cfdf9

23 files changed

+80969
-80169
lines changed

dev/.documenter-siteinfo.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"documenter":{"julia_version":"1.11.6","generation_timestamp":"2025-08-26T05:39:11","documenter_version":"1.14.1"}}
1+
{"documenter":{"julia_version":"1.11.6","generation_timestamp":"2025-08-26T06:21:08","documenter_version":"1.14.1"}}

dev/api/index.html

Lines changed: 4 additions & 4 deletions
Large diffs are not rendered by default.

dev/cib/8d624de9.svg

Lines changed: 0 additions & 44345 deletions
This file was deleted.

dev/cib/c86ad964.svg

Lines changed: 44341 additions & 0 deletions
Loading

dev/cib/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
# sort
88
ra, dec, redshift, halo_mass = sort_halo_catalog(ra, dec, redshift, halo_mass)
99

10-
print(&quot;Number of halos: &quot;, length(halo_mass))</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi"> Downloading artifact: tsz_example
10+
print(&quot;Number of halos: &quot;, length(halo_mass))</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi"><span class="sgr32"><span class="sgr1"> Downloading</span></span> artifact: tsz_example
1111
Number of halos: 2455621</code></pre><p>Next, we&#39;ll generate a cosmology. Note how we use Float32 throughout.</p><pre><code class="language-julia hljs">cosmo = get_cosmology(h=0.6774f0, OmegaM=0.3075f0)
1212
x, y, z = XGPaint.ra_dec_redshift_to_xyz(ra, dec, redshift, cosmo)
1313
halo_pos = [x&#39;; y&#39;; z&#39;;]
@@ -44,7 +44,7 @@
4444
shape, wcs = geometry(CarClenshawCurtis{Float64}, box, 0.5 * Pixell.arcminute)
4545
m = Enmap(zeros(Float32, shape), wcs)
4646
XGPaint.paint!(m, 143.0f0 * 1.0f9, model, sources, fluxes_cen, fluxes_sat)
47-
plot(log10.(m), c=:coolwarm)</code></pre><img src="8d624de9.svg" alt="Example block output"/><h2 id="Sources-from-HDF5"><a class="docs-heading-anchor" href="#Sources-from-HDF5">Sources from HDF5</a><a id="Sources-from-HDF5-1"></a><a class="docs-heading-anchor-permalink" href="#Sources-from-HDF5" title="Permalink"></a></h2><p>To work with the Websky halo catalogs, you can&#39;t just use the example catalogs! One first loads the halo positions and masses into memory with <a href="../api/#XGPaint.read_halo_catalog_hdf5-Tuple{Any}"><code>read_halo_catalog_hdf5</code></a>. This package uses halo positions in the shape <span>$(3, N_{\mathrm{halos}})$</span>, where the first dimension is the Cartesian coordinates <span>$x, y, z$</span>.</p><pre><code class="language-julia hljs">using XGPaint
47+
plot(log10.(m), c=:coolwarm)</code></pre><img src="c86ad964.svg" alt="Example block output"/><h2 id="Sources-from-HDF5"><a class="docs-heading-anchor" href="#Sources-from-HDF5">Sources from HDF5</a><a id="Sources-from-HDF5-1"></a><a class="docs-heading-anchor-permalink" href="#Sources-from-HDF5" title="Permalink"></a></h2><p>To work with the Websky halo catalogs, you can&#39;t just use the example catalogs! One first loads the halo positions and masses into memory with <a href="../api/#XGPaint.read_halo_catalog_hdf5-Tuple{Any}"><code>read_halo_catalog_hdf5</code></a>. This package uses halo positions in the shape <span>$(3, N_{\mathrm{halos}})$</span>, where the first dimension is the Cartesian coordinates <span>$x, y, z$</span>.</p><pre><code class="language-julia hljs">using XGPaint
4848
using Healpix
4949

5050
## Load halos from HDF5 files, establish a CIB model and cosmology
@@ -109,4 +109,4 @@
109109
# for this test, do it only on a subset of the halos
110110
sources = generate_sources(custom_model, cosmo, halo_pos[:,1:10], halo_mass[1:10])
111111

112-
print(sources.lum_cen)</code></pre><p>This particular change zeros out the luminosities, and indeed you should see the result is an array of zeroes.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../rsz/">« Relativistic Sunyaev–Zeldovich Effect</a><a class="docs-footer-nextpage" href="../api/">API »</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="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.14.1 on <span class="colophon-date" title="Tuesday 26 August 2025 05:38">Tuesday 26 August 2025</span>. Using Julia version 1.11.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
112+
print(sources.lum_cen)</code></pre><p>This particular change zeros out the luminosities, and indeed you should see the result is an array of zeroes.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../rsz/">« Relativistic Sunyaev–Zeldovich Effect</a><a class="docs-footer-nextpage" href="../api/">API »</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="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.14.1 on <span class="colophon-date" title="Tuesday 26 August 2025 06:20">Tuesday 26 August 2025</span>. Using Julia version 1.11.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/developer_notes/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
<!DOCTYPE html>
22
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Developer Notes · XGPaint.jl</title><meta name="title" content="Developer Notes · XGPaint.jl"/><meta property="og:title" content="Developer Notes · XGPaint.jl"/><meta property="twitter:title" content="Developer Notes · XGPaint.jl"/><meta name="description" content="Documentation for XGPaint.jl."/><meta property="og:description" content="Documentation for XGPaint.jl."/><meta property="twitter:description" content="Documentation for XGPaint.jl."/><meta property="og:url" content="https://github.com/WebSky-CITA/XGPaint.jl/developer_notes/"/><meta property="twitter:url" content="https://github.com/WebSky-CITA/XGPaint.jl/developer_notes/"/><link rel="canonical" href="https://github.com/WebSky-CITA/XGPaint.jl/developer_notes/"/><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.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/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="../search_index.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/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><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><link href="../assets/custom.css" rel="stylesheet" type="text/css"/></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">XGPaint.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../sz/">Sunyaev–Zeldovich Effect</a></li><li><a class="tocitem" href="../ksz/">Kinetic Sunyaev–Zeldovich Effect</a></li><li><a class="tocitem" href="../rsz/">Relativistic Sunyaev–Zeldovich Effect</a></li><li><a class="tocitem" href="../cib/">Cosmic Infrared Background</a></li><li><a class="tocitem" href="../api/">API</a></li><li class="is-active"><a class="tocitem" href>Developer Notes</a><ul class="internal"><li><a class="tocitem" href="#Package-development"><span>Package development</span></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"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Developer Notes</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Developer Notes</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/WebSky-CITA/XGPaint.jl/blob/main/docs/src/developer_notes.md#L" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Developer-Notes"><a class="docs-heading-anchor" href="#Developer-Notes">Developer Notes</a><a id="Developer-Notes-1"></a><a class="docs-heading-anchor-permalink" href="#Developer-Notes" title="Permalink"></a></h1><p>If you&#39;re new to the <a href="https://julialang.org/">Julia language</a>, my favorite tutorial is this <a href="https://julia.quantecon.org/intro.html">Introduction to Julia for Quantitative Economics</a>. Sections 1-13 are the most relevant if you are an astronomer, but some of later numerical techniques can also be useful. Computing clusters will often have a Julia module; make sure you load a Julia version 1.6 or later. </p><p>For your development computer, download the <a href="https://julialang.org/downloads/">precompiled binaries</a> and add the Julia executable to your <code>$PATH</code>. Do not use a package manager to install Julia. The Julia compiler has a heavily modified glibc, which many package managers misconfigure (such as the AUR). Rust also faces this problem.</p><h2 id="Package-development"><a class="docs-heading-anchor" href="#Package-development">Package development</a><a id="Package-development-1"></a><a class="docs-heading-anchor-permalink" href="#Package-development" title="Permalink"></a></h2><p>To make changes to this package, start up the Julia interpeter and run</p><pre><code class="language-julia-repl hljs">julia&gt; ] dev git@github.com:WebSky-CITA/XGPaint.jl.git</code></pre><p>By default, this will place a copy of this package&#39;s repository in your home directory, <code>~/.julia/dev/XGPaint</code>. Changes to the code in this folder will be reflected in your global environment.</p><p>It can be helpful to write documentation alongside a live preview. This is accomplished with the <a href="https://github.com/tlienart/LiveServer.jl">LiveServer</a> package. You should install the <code>LiveServer</code> and <code>Documenter</code> packages. If you have a standard Julia installlation, you can run from the command line,</p><pre><code class="language-bash hljs">cd $HOME/.julia/dev/XGPaint
3-
julia --project=. -e &quot;using XGPaint, LiveServer; servedocs()&quot;</code></pre><p>This will render HTML pages and provide an HTTP server for local previews. The documentation will automatically update when you make changes.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../api/">« API</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="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.14.1 on <span class="colophon-date" title="Tuesday 26 August 2025 05:38">Tuesday 26 August 2025</span>. Using Julia version 1.11.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
3+
julia --project=. -e &quot;using XGPaint, LiveServer; servedocs()&quot;</code></pre><p>This will render HTML pages and provide an HTTP server for local previews. The documentation will automatically update when you make changes.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../api/">« API</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="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.14.1 on <span class="colophon-date" title="Tuesday 26 August 2025 06:20">Tuesday 26 August 2025</span>. Using Julia version 1.11.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 commit comments

Comments
 (0)