Skip to main content

package to compute integrals related to spherical Jeans equation, including various parametric functions to describe halo and tracer components

Project description

jeans

A package for calculating properties of (spherical) dark matter halos and embedded (spherical) stellar populations, including integration of the (spherical) Jeans equation in 2D (observed projections) and 3D.

Author: Matthew G. Walker (2024)

Instructions

  • Install jeans. You can either pip install the released version or install from github
pip install jeans

Available Dark Matter Halo Models

The alpha/beta/gamma ('abg_triangle') halo has mass density profile $\rho(r)=\frac{\rho_s}{(r/r_s)^{\gamma}[1+(r/r_s)^{\alpha}]^{(\beta-\gamma)/\alpha}}$.

The Navarro-Frenk-White ('nfw') halo is a special case of the above, with $(\alpha,\beta,\gamma)=(1,3,1)$, but can be called directly.

The Dehnen Cusp ('dehnen_cusp') halo is a special case of the 'abg' halo, with $(\alpha,\beta,\gamma)=(1,4,1)$, but can be called directly.

The Dehnen Core ('dehnen_core') halo is a special case of the 'abg' halo, with $(\alpha,\beta,\gamma)=(1,4,0)$, but can be called directly.

The core-NFW ('cnfw') halo is by Read et al. (arXiv:1805.06934), defined in terms of the enclosed mass profile, $M_{\rm cNFW}(r)=M_{\rm NFW}(r)f^n$, where $M_{\rm NFW}(r)$ is the enclosed mass profile of the NFW halo and $f^n=[\tanh(r/r_c)]^n$, with $r_c$ a core radius.

The core-NFW-tides ('cnfwt') halo is by Read et al. (arXiv:1805.06934), with density profile $\rho_{\rm cNFWt}(r)=\rho_{\rm cNFW}(r)$ for $r<r_{\rm t}$ and $\rho_{\rm cNFWt}(r)=\rho_{\rm cNFW}(r_{\rm t})(r/r_{\rm t})^{-\delta}$, allowing for power-law decrease in density beyond `tidal' radius $r_{\rm t}$.

For cNFW and cNFWt models, the standard definitions of parameters $M_{\triangle}$, $c_{\triangle}$ and $r_{\triangle}$ apply to the density and mass profile of the corresponding NFW halo that would be obtained by setting $r_{\rm c}=0$ and $r_{\rm t}=\infty$.

Available Models for Tracer component

The alpha/beta/gamma ('abg') model has number density profile $\nu(r)=\frac{\nu_0}{(r/r_s)^{\gamma}[1+(r/r_s)^{\alpha}]^{(\beta-\gamma)/\alpha}}$.

The Plummer model ('plum') is a special case of the 'abg' model, with $(\alpha,\beta,\gamma)=(2,5,0)$, but can be called directly.

The 'a2bg' model is a special case of the 'abg' model, with $\alpha=2$, but can be called directly.

The exponential model 'exp' is defined in terms of projected density, $\Sigma(R)=\Sigma_0\exp(-R/r_s)$.

Available Models for velocity dispersion anisotropy of the tracer component

The only model currently implemented is that of Read et al. (arXiv:1805.06934): $\beta(r)\equiv 1-\sigma^2_{\rm t}/\sigma^2_{\rm r}=\beta_0+(\beta_{\infty}-\beta_0)/(1+(r/r_{\beta})^{-n})$, where $\sigma_{\rm r}$ is the radial component of the velocity dispersion and $\sigma_{\rm t}=\sigma_{\theta}=\sigma_{\phi}$ is the tangential component (the two angular components have equal magnitude in the absence of rotation).

Usage

See notebook in the examples folder.

Examples

See notebook in the examples folder.

Acknowledgement

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jeans-2.2.4.tar.gz (13.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jeans-2.2.4-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

Details for the file jeans-2.2.4.tar.gz.

File metadata

  • Download URL: jeans-2.2.4.tar.gz
  • Upload date:
  • Size: 13.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.8

File hashes

Hashes for jeans-2.2.4.tar.gz
Algorithm Hash digest
SHA256 e7e21bfc9ac13ba4607345ce42a04eb24fd3d63d4d862da5ca5f75f5677bf68e
MD5 54d24f45d7a74063bc8f02d5f8ae3756
BLAKE2b-256 d45357199638c0271ceaf8c886ed68bf06cc3fed047fcab9ace27e40bb650320

See more details on using hashes here.

File details

Details for the file jeans-2.2.4-py3-none-any.whl.

File metadata

  • Download URL: jeans-2.2.4-py3-none-any.whl
  • Upload date:
  • Size: 12.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.8

File hashes

Hashes for jeans-2.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 0cdc9f5c6945ab37410479980343566ec69b9fc70a3926866182ae48b0fcea4a
MD5 0d01a92244abf1f08aa36856a84bad18
BLAKE2b-256 74fbcc220b75428b23895fda5845e3daa907deb49a26b2d0ca2150a1bc5e1a4a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page