Skip to main content

Dark matter halo properties and halo mass functions using JAX

Project description

logo

halox

JAX-powered Python library for differentiable dark matter halo property and mass function calculations.

License: MIT tests coverage PyPi version Documentation Status arXiv

Installation

halox can be installed via pip:

pip install halox

For a manual installation, see the documentation pages.

Features

halox offers a JAX-powered differentiable and GPU-accelerated implementation of some widely used properties of dark matter halos and large-scale structure, including:

  • halox.halo: Radial profiles of dark matter halos following Navarro-Frenk-White (NFW) and Einasto distributions;
  • halox.cm: Mass-concentration relations of dark matter halos;
  • halox.hmf: The halo mass function, quantifying the abundance of dark matter halos in mass and redshift and its dependence on cosmological parameters;
  • halox.bias: The halo bias.

All properties support cosmology dependence using jax-cosmo. More information on the modules available can be found in the documentation pages.

Testing

All functions available in halox are validated against existing, non-JAX-based software. Cosmology calculations are validated against Astropy for varying cosmological parameters and redshifts. Other quantities are validated against Colossus or gala for varying halo masses, redshifts, critical overdensities, and cosmological parameters. These tests are included in the automatic CI/CD pipeline; a visual comparison is also included in the documentation.

Documentation

For more detail on the code and features, please visit our documentation pages.

Citation

If you use halox for your research, please cite the original paper:

@ARTICLE{2025arXiv250922478K,
       author = {{K{\'e}ruzor{\'e}}, Florian},
        title = "{halox: Dark matter halo properties and large-scale structure calculations using JAX}",
      journal = {arXiv e-prints},
     keywords = {Instrumentation and Methods for Astrophysics, Cosmology and Nongalactic Astrophysics},
         year = 2025,
        month = sep,
          eid = {arXiv:2509.22478},
        pages = {arXiv:2509.22478},
          doi = {10.48550/arXiv.2509.22478},
archivePrefix = {arXiv},
       eprint = {2509.22478},
 primaryClass = {astro-ph.IM},
}

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

halox-1.2.1.tar.gz (2.9 MB view details)

Uploaded Source

Built Distribution

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

halox-1.2.1-py3-none-any.whl (16.8 kB view details)

Uploaded Python 3

File details

Details for the file halox-1.2.1.tar.gz.

File metadata

  • Download URL: halox-1.2.1.tar.gz
  • Upload date:
  • Size: 2.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.4 {"installer":{"name":"uv","version":"0.10.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for halox-1.2.1.tar.gz
Algorithm Hash digest
SHA256 ece0abe2004f6e0a097223738499266bf6c7072679556a4674afdfb689cac140
MD5 f7c23dcfe338bc103a48c1346d65637c
BLAKE2b-256 2962b37657f732a6dabfbee4822497ef10b6580efadb4c230f854aef7ca18e49

See more details on using hashes here.

File details

Details for the file halox-1.2.1-py3-none-any.whl.

File metadata

  • Download URL: halox-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 16.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.4 {"installer":{"name":"uv","version":"0.10.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for halox-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1fd3616c1efc94dc2ddf3d1618c988b700b71b4789f217e469e8825a4de7d7bd
MD5 166d8ec9050881486520a16d3de4827e
BLAKE2b-256 340fbbd1286d9351122c94b21fc0b390bd3ff4860f3f4a4802f4d10d00fbe1e6

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