vsdm

Vector space dark matter rate calculation

https://github.com/blillard/vsdm

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
    Links to: arxiv.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.8%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Vector space dark matter rate calculation

Basic Info
  • Host: GitHub
  • Owner: blillard
  • License: mit
  • Language: Jupyter Notebook
  • Default Branch: main
  • Size: 41 MB
Statistics
  • Stars: 4
  • Watchers: 2
  • Forks: 1
  • Open Issues: 0
  • Releases: 0
Created about 3 years ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

vsdm

By Benjamin Lillard

Vector space dark matter rate calculation

arXiv arXiv

DESCRIPTION:

VSDM is the Python implementation of the wavelet-harmonic integration method, designed for the efficient calculation of dark matter direct detection scattering rates in anisotropic detectors, and for arbitrary dark matter velocity distributions. Each input function is projected onto a basis of orthogonal functions (spherical harmonics and wavelets), so that the scattering rate calculation becomes a linear operation on the vector space representations of the functions. This method is introduced in arXiv:2310.01480, with the relevant details worked out in arXiv:2310.01483.

Version 0.3 of this code introduces an adaptive integration method for projecting 3d functions onto the wavelet-harmonic basis, based on the "wavelet extrapolation" identified in arXiv:2310.01483. The new AdaptiveFn and WaveletFnlm routines use a polynomial approximation (at linear, cubic, or 7th order) to predict the next generation of wavelet coefficients. In the "refining" stage of the calculation, WaveletFnlm selectively evaluates additional wavelet coefficients until the predictions from the local polynomial expansions match the results from numerical integration everywhere in the space, within some specified precision goal.

The spherical harmonic functions are also improved in this version. The new normalized associated Legendre function in utilities.py uses just-in-time compilation and an iterative numerical method to gain a factor of 20-25 in speed compared to v0.1, while permitting precise calculations at much larger values of (l, m). Accuracy has been verified out to $\ell = 1800$, where the absolute accuracy on $P_\ell^m(x)$ is better than $10^{-10}$ for all $m$ and $x$.

Version 0.4 adds support for velocity-dependent cross sections, of the form $\sigma(q, v) = \sigma0 (q/qr)^a (v / vr)^b$ for arbitrary powers $a$ and $b$. The reference momentum $qr$ and velocity $vr$ are defined in units.py as q0fdm and v0fdm, respectively, with default values $qr = \alpha me c$ and $vr = c$.

A few explanatory notebooks are included in the 'tools' directory: - Calculating Coefficients: demonstrates how to calculate the wavelet-harmonic coefficients using the Fnlm and EvaluateFnlm classes, and how to import saved coefficients from a csv file. - Rate Calculation: provides a few examples of how to perform the rate calculation for arbitrary detector orientations with respect to the dark matter velocity distribution. - Wigner D and G: a brief introduction to the Wigner $D^{(\ell)}$ and $G^{(\ell)}$ matrices, which encode the action of rotations on complex or real spherical harmonics (respectively).

The 'tools' directory also includes three sample Python codes: - demo_fs2.py: uses the WaveletFnlm method to calculate batches of wavelet-harmonic coefficients $\langle fs^2 | n \ell m \rangle$, for the particle-in-a-box momentum form factors $fs^2({q})$ used in the demonstration notebooks and arXiv:2310.01483. - demo_gX.py: calculates $\langle g\chi | n \ell m \rangle$ for a velocity distribution example $g\chi({v})$, defined as the sum of four Gaussians with different average velocities and dispersions. This is the velocity distribution used in "Calculating Coefficients" and "Rate Calculation". - SHM_gX.py: this tool calculates the wavelet-harmonic expansion for the Standard Halo Model (SHM) velocity distribution, as a function of galactic frame Earth velocity, using the adaptive WaveletFnlm method.

Four CSV files are included in the 'demo' directory: - 'demofs2.csv' and 'demofs2alt.csv', with the values of $\langle fs^2 | n \ell m \rangle$ for the ${n} = (1, 1, 2)$ and ${n} = (3, 2, 1)$ excited states, respectively, of the particle-in-a-box model. - 'gXmodel4.csv': $\langle g\chi | n \ell m \rangle$ for the four-gaussian velocity distribution. - 'SHMv250.csv': $\langle g\chi | n \ell m \rangle$ for the Standard Halo Model, with a dark matter wind speed of 250 km/s. The galactic escape velocity and local group circular speed are set to 544 km/s and 238 km/s, respectively.

Owner

  • Login: blillard
  • Kind: user

Citation (CITATION.cff)

cff-version: 1.2.0
title: VSDM
message: "If you use this software, please cite it as below and reference the arXiv.org preprints 2310.01480 and 2310.01483"
type: software
authors:
  - given-names: Ben
    family-names: Lillard
    email: blillard@uoregon.edu
    affiliation: University of Oregon
    orcid: 'https://orcid.org/0000-0001-8496-4808'
version: 0.1.0
date-released: 2023-10-02

GitHub Events

Total
  • Delete event: 2
  • Push event: 36
  • Pull request event: 4
  • Create event: 1
Last Year
  • Delete event: 2
  • Push event: 36
  • Pull request event: 4
  • Create event: 1

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 0
  • Total pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: 5 minutes
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: 5 minutes
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
  • blillard (2)
  • ariaradick (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 31 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 16
  • Total maintainers: 1
pypi.org: vsdm

Vector space integration for dark matter direct detection

  • Versions: 16
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 31 Last month
Rankings
Dependent packages count: 9.8%
Average: 38.8%
Dependent repos count: 67.8%
Maintainers (1)
Last synced: 10 months ago