API Reference

The reference is organized by simulation task. The user-facing groups contain the interfaces expected in simulation scripts. Advanced and internal interfaces covers specialized workflows, while Internal interfaces provides the complete low-level solver, backend, and validation interfaces whose signatures may evolve.

Start with Your first simulation for a complete runnable pipeline or Notebook Gallery for pre-executed examples.

• Configuration and runtime selection
  • Configuration
  • Multi-GPU configuration
  • Device mesh construction
• Cosmology and initial conditions
  • Cosmology objects
  • Differentiable parameter selection
  • Background expansion
  • Transfer, growth, and variance
  • Random and linear modes
  • Lagrangian perturbation theory
• Particles and evolution
  • Particle state and constructors
  • Forward evolution
  • Particle–mesh operators
• Analysis and plotting
  • Power spectra
  • Cross spectra and correlation
  • Diagnostic plotting
• Advanced and internal interfaces
  • Runtime construction
  • Integration and adjoint steps
  • Mesh-halo primitives
  • Distributed FFT construction
  • Particle routing and halo movement
  • Utilities
  • Optional CAMELS adapter
• Internal interfaces
  • Derived configuration properties
  • Cosmology properties and cotangents
  • Transfer and mode construction
  • Particle-state helpers
  • Gravity and particle–mesh primitives
  • Integration and adjoint internals
  • Halo runtime initializers
  • CUDA routing
  • CUDA extension build and discovery
  • Pallas CIC kernels
  • ODE implementation
  • General utilities