bayes_pol
Bayesian Spectral Polarization Models
bayes_pol implements models to infer the physics of the interstellar medium from radio continuum polarization observations.
Installation
Basic Installation
Install with pip in a conda virtual environment:
conda create --name bayes_pol -c conda-forge pymc>=5.20 pip
conda activate bayes_pol
pip install bayes_pol
Development installation
Alternatively, download and unpack the latest release, or fork the repository and contribute to the development of bayes_pol!
Install in a conda virtual environment:
conda env create -f environment.yml
conda activate bayes_pol-dev
pip install -e .
Models
The models provided by bayes_pol are implemented in the bayes_spec framework. bayes_spec assumes that the source of the polarization signal can be decomposed into a series of "clouds" with Gaussian-like Faraday depth distributions, each of which is defined by a set of model parameters. Here we describe the models available in bayes_pol.
FaradayModel
The FaradayModel predicts observations of Stokes Q, U, and Faraday depth (the Fourier transform of the complex polarization) by assuming the polarized intensity is modified by a series of "clouds" in Faraday depth space. The following diagram demonstrates the relationship between the free parameters (empty ellipses), deterministic quantities (rectangles), model predictions (filled ellipses), and observations (filled, round rectangles). Many of the parameters are internally normalized (and thus have names like _norm). The subsequent tables describe the model parameters in more detail.
Cloud Parametervariable |
Parameter | Units | Prior, where ($p_0, p_1, \dots$) = prior_{variable} |
Defaultprior_{variable} |
|---|---|---|---|---|
polarized_intensity |
Polarized intensity | data brightness | $P_I \sim {\rm HalfNormal}(\sigma=p)$ | 100.0 |
faraday_depth_mean |
Mean Faraday depth | rad/m2 |
$\langle F \rangle \sim {\rm Cauchy}(\alpha=p_0, \beta=p_1)$ | [0.0, 1000.0] |
faraday_depth_fwhm |
Faraday depth FWHM | rad/m2 |
$\Delta F \sim {\rm HalfNormal}(\sigma=p)$ | 10.0 |
pol_angle0 |
Polarization angle at $\lambda = 0$ | rad |
$\phi_0 \sim {\rm Uniform}(-\pi/2, \pi/2)$ |
Syntax & Examples
See the various tutorial notebooks under docs/source/notebooks. Tutorials and the full API are available here: https://bayes-pol.readthedocs.io.
Issues and Contributing
Anyone is welcome to submit issues or contribute to the development of this software via Github.
License and Copyright
Copyright(C) 2025 by Trey V. Wenger
This code is licensed under MIT license (see LICENSE for details)
1 maintainer
Release files for bayes-pol 1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| bayes_pol-1.1.tar.gz | 25.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| bayes_pol-1.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 32.5 kB
Release files / bayes_pol-1.1.tar.gz
| Download URL | bayes_pol-1.1.tar.gz |
|---|---|
| Size | 25.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b398607cc933d1727d21547d316102f4bbc115c8a8f5c7d4f932b52171803205
|
|
BLAKE2b-256 checksum How to use checksums |
ded47f72359e365f25c5f9a22cff99cc18740e9d5b92fb83a4861034487537cc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.8
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Feb 4, 2025.
Transparency logRelease files / bayes_pol-1.1-py3-none-any.whl
| Download URL | bayes_pol-1.1-py3-none-any.whl |
|---|---|
| Size | 7.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5b24919e5e2fc78f8fae4d4e44cfeda8c0ae4818fcf31725b2a11d6a287abf2f
|
|
BLAKE2b-256 checksum How to use checksums |
d0b4a7667ed340905dec3ea94b0fd6fd0e05b3dd7ba37e306e235cb5aaa98aba
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.8
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Feb 4, 2025.
Transparency log
