Bolometric sensitivity calculator for CMB instruments
Project description
bolojax
Bolometric sensitivity calculator for CMB instruments, built on JAX.
bolojax models the full radiative transfer chain of a CMB telescope and computes noise-equivalent temperature (NET), noise-equivalent power (NEP), and mapping speed. Because the compute path is written in pure JAX, the entire forward model is automatically differentiable, enabling gradient-based fitting, Fisher forecasting, MCMC sampling, and potentially inverse design.
History
This package descends from BoloCalc by Charlie Hill (arXiv:1806.04316), which was subsequently forked and restructured by Eric Charles at KIPAC/bolo-calc. bolojax is a fork of bolo-calc that replaces the configuration layer with pydantic and the numerical backend with JAX, equinox, and zodiax, making the sensitivity calculation JIT-compiled and fully differentiable.
What you can do
| Task | Before (BoloCalc / bolo-calc) | With bolojax |
|---|---|---|
| Forward modeling | Supported (YAML config only) | Supported, JIT-compiled |
| Monte Carlo (posterior predictive) | Supported (sample parameters, run many realizations) | Supported, faster with JIT |
| Least-squares fitting | Subprocess wrapper, finite-difference Jacobians | Exact Jacobians through autodiff |
| Fisher analysis | Limited by finite-difference accuracy and subprocess overhead | Exact Fisher matrix in a single JIT-compiled pass |
| MCMC / HMC | Not practical (no gradients) | Enabled by autodiff |
Installation
uv pip install bolojax
For GPU support:
uv pip install 'bolojax[gpu]'
Architecture
bolojax separates configuration (pydantic) from computation (JAX/zodiax):
Config layer (pydantic) Compute layer (zodiax/JAX)
─────────────────────── ──────────────────────────
ExperimentConfig Experiment
SimConfig Instrument
Universe elements: {name: Element}
InstrumentConfig Tc, bath_temp, psat, ...
Optics fsky, obs_time, obs_effic
CameraConfig SensitivityResult
ChannelConfig NET, NEP, powers, ...
ExperimentConfig.setup() bridges the two layers, returning an Experiment
zodiax pytree that you compute with, differentiate through, and modify with
.set().
Quick start
YAML-driven
import bolojax
config = bolojax.ExperimentConfig.from_yaml("config/example.yaml")
experiment = config.setup()
# Compute and export
ds = experiment.to_dataset()
ds.to_netcdf("results.nc")
Or from the command line:
bolojax -i config/example.yaml -o results.nc
Programmatic
import bolojax
import equinox as eqx
# 1. Load configuration and set up the compute object
config = bolojax.ExperimentConfig.from_yaml("config/example.yaml")
experiment = config.setup()
# 2. Compute sensitivity
result = experiment.compute()
print(f"NET = {result.NET.squeeze() * 1e6:.2f} uK-rts")
# 3. Get labeled xarray output
ds = experiment.to_dataset()
ds.to_netcdf("results.nc")
# 4. Modify parameters and recompute
exp2 = experiment.set("instrument.elements.window.loss_tangent", 2.5e-4)
result2 = exp2.compute()
# 5. Differentiate (filter_grad skips non-float leaves like ndet)
@eqx.filter_grad
def grad_net(exp):
return exp.compute().NET.squeeze()
g = grad_net(experiment)
Optical element types
Each element in the optical chain has a type field and computes its own
emissivity and transmission from physical properties. Quantities can include
units.:
elements:
- forebaffle:
temperature: "240 K"
scatter_frac: 0.013
- window:
type: dielectric
temperature: "260 K"
thickness: "0.025 m"
index: 1.5246
loss_tangent: 1.38e-4
reflection: 0.01
- primary:
type: mirror
temperature: "273 K"
conductivity: 3.6e7
- aperture:
type: aperture_stop
temperature: "5.5 K"
spillover: 0.15
License
BSD 3-Clause. See LICENSE for details.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file bolojax-0.7.0.tar.gz.
File metadata
- Download URL: bolojax-0.7.0.tar.gz
- Upload date:
- Size: 40.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
eec338131899aefd4f711820f248b3f79f42a0b8a504e2372ec658c32f2a4a52
|
|
| MD5 |
5823e933810f6aea63ffdaa75c31e22f
|
|
| BLAKE2b-256 |
1161508ae0b34604e621a3c49ff29609056c46277664bf5cbdf72b8075cf2bf4
|
Provenance
The following attestation bundles were made for bolojax-0.7.0.tar.gz:
Publisher:
release.yaml on bdelwood/bolojax
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
bolojax-0.7.0.tar.gz -
Subject digest:
eec338131899aefd4f711820f248b3f79f42a0b8a504e2372ec658c32f2a4a52 - Sigstore transparency entry: 1360399508
- Sigstore integration time:
-
Permalink:
bdelwood/bolojax@31a63cef15bf2c51a5ff50f538c0f57ace7c399b -
Branch / Tag:
refs/tags/v0.7.0 - Owner: https://github.com/bdelwood
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yaml@31a63cef15bf2c51a5ff50f538c0f57ace7c399b -
Trigger Event:
push
-
Statement type:
File details
Details for the file bolojax-0.7.0-py3-none-any.whl.
File metadata
- Download URL: bolojax-0.7.0-py3-none-any.whl
- Upload date:
- Size: 49.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
867d0b5e4826bdb501c6c8ca1a84211873d779305b30d82ee30a1f1ab213ec2b
|
|
| MD5 |
65e5dc9747021f264b180b1cc4be8dd4
|
|
| BLAKE2b-256 |
554907a70d3d48f40cdc1d9147a60464f6b3c2cf6dda92f36d908d3877ba6723
|
Provenance
The following attestation bundles were made for bolojax-0.7.0-py3-none-any.whl:
Publisher:
release.yaml on bdelwood/bolojax
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
bolojax-0.7.0-py3-none-any.whl -
Subject digest:
867d0b5e4826bdb501c6c8ca1a84211873d779305b30d82ee30a1f1ab213ec2b - Sigstore transparency entry: 1360399540
- Sigstore integration time:
-
Permalink:
bdelwood/bolojax@31a63cef15bf2c51a5ff50f538c0f57ace7c399b -
Branch / Tag:
refs/tags/v0.7.0 - Owner: https://github.com/bdelwood
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yaml@31a63cef15bf2c51a5ff50f538c0f57ace7c399b -
Trigger Event:
push
-
Statement type: