darkmatter 0.0.2

Dark matter simulation engine — gravitational fields, particle dynamics, halo stability, and cosmological constants
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

# DarkMatter

> Part of the [Celestial](https://celestial4498-prog.github.io/Celestial/) project

[![Crates.io](https://img.shields.io/crates/v/darkmatter)](https://crates.io/crates/darkmatter)
[![docs.rs](https://img.shields.io/docsrs/darkmatter)](https://docs.rs/darkmatter)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

A comprehensive Rust library for dark matter physics — covering candidate models, halo profiles, cosmological observables, detection channels, N-body dynamics, and large-scale structure.

---

## Scope

DarkMatter provides 12 modules spanning the full breadth of dark matter research:

| Module | Description |
|---|---|
| **candidates** | WIMPs, axions, fuzzy DM, warm DM, asymmetric DM, primordial black holes |
| **clusters** | Galaxy cluster dynamics, ICM, mass functions |
| **constants** | Physical and cosmological constants |
| **cosmology** | Boltzmann solver, CMB, relic abundance, reionization, structure formation, 21 cm |
| **detection** | Direct, indirect, collider, gravitational waves, spectra, EFT, dark sector |
| **dynamics** | Barnes-Hut tree, N-body, dynamical friction, tidal stripping, stability |
| **galaxy** | Formation, mergers, rotation curves |
| **halos** | NFW/Einasto/Burkert profiles, contraction, spikes, substructure |
| **large_scale** | Correlation functions, filaments, voids |
| **physics** | Gravity, lensing, SIDM, Sommerfeld enhancement, phase space, thermodynamics |
| **solar_system** | Capture, local density, orbital perturbations |
| **utils** | Unit conversions, ODE solvers, special functions, statistics |

## Quick Start

Add to your `Cargo.toml`:

```toml
[dependencies]
darkmatter = "*"
```

```rust
use darkmatter::halos::profiles;
use darkmatter::constants::physical;

let r = 8.0 * physical::KPC;
let rho = profiles::nfw_density(r, 1e12 * physical::SOLAR_MASS, 10.0);
```

## Stats

- **69** source files across **12** modules
- **781+** public items (functions, structs, enums)
- **~6 900** lines of physics code
- **87** integration tests in **7** test files
- **7** runnable examples

## Examples

Run any example with:

```bash
cargo run --example fuzzy_dm_example
cargo run --example sommerfeld_example
cargo run --example barnes_hut_example
cargo run --example boltzmann_example
cargo run --example gravitational_waves_example
cargo run --example phase_space_example
cargo run --example spectra_example
```

## Dependencies

- [sciforge](https://crates.io/crates/sciforge) — scientific computing foundation

## License

MIT — see [LICENSE](LICENSE)