HIcosmo Documentation

HIcosmo is a high-performance framework for cosmological parameter estimation and forecasting, with core goals of: minimal API, smart defaults, performance-first, and extensibility.

Quick Links

• Getting started: Quick Start

• Technical foundation: JAX Technical Guide

• Parameters and likelihoods: Likelihood Functions

• Configuration-driven: Configuration Guide

• Complete API: API Reference

This documentation follows the Read the Docs style inspired by Cobaya, providing clear structured navigation: - Installation and getting started - Core concepts and usage guides - Detailed API reference (with entry points for every interface)

Getting Started

• Installation Guide
  • System Requirements
  • Basic Installation
  • Development Installation
  • GPU Acceleration
  • Core Dependencies
  • Optional Dependencies
  • Verifying Installation
  • Troubleshooting
  • CI/CD Environment Configuration
  • Read the Docs Build
• Quick Start
  • Inference in 3 Lines of Code
  • Basic Examples
  • Supported Likelihood Strings
  • Extended Dark Energy Models
  • Custom Likelihood Functions
  • Using the Class Interface (Advanced)
  • Visualizing Results
  • Saving and Loading Results
  • YAML Configuration-Driven
  • Next Steps
• Core Concepts
  • Design Philosophy
  • Six-Layer Architecture
  • Module Responsibility Boundaries
  • Parameter System
  • Distance Calculations
  • Data Management
  • Performance Characteristics
  • Next Steps
• JAX Technical Deep Dive
  • What is JAX?
  • Functional Programming: The Core Philosophy of JAX
  • The Four Core Features of JAX
  • PRNG Random Number Management
  • JAX in Cosmology
  • Performance Data and Benchmarks
  • Why HIcosmo Chose JAX
  • JAX vs Other Frameworks
  • Common JAX Pitfalls and Solutions
  • HIcosmo’s JAX Usage Patterns
  • Learning Resources
  • Summary
  • Next Steps

User Guides

• Dataset Management
  • Viewing Available Datasets
  • Dataset Categories
  • Using Discovered Datasets
  • Default Data Directory
  • Adding New Datasets
  • DataRegistry Advanced Usage
  • Complete Example
• Cosmological Models
  • Model Overview
  • Basic Theory
  • LCDM Model
  • wCDM Model
  • CPL Model
  • ILCDM Model
  • Traced-Aware Interface
  • Preset Parameters
  • Adding New Cosmological Models
  • Performance Optimization
  • Best Practices
  • Next Steps
• Likelihood Functions
  • Likelihood Function Overview
  • Unified API Design
  • Type Ia Supernovae (SNe Ia)
  • BAO (Baryon Acoustic Oscillations)
  • CMB Distance Priors
  • Strong Gravitational Lensing
  • SH0ES
  • Joint Likelihood
  • Nuisance Parameters
  • Integration with MCMC
  • Performance Optimization
  • Adding Custom Likelihood Functions
  • Next Steps
• Sampling and Inference
  • Sampler Overview
  • Quick Start
  • High-Level API
  • MCMC Class Interface
  • Multiple Sampler Backends
  • Run Configuration
  • Checkpoint System
  • Convergence Diagnostics
  • Result Handling
  • Automatic Nuisance Parameter Collection
  • Performance Optimization
  • Complete Example
  • Next Steps
• Custom Likelihood Functions
  • Why Use HIcosmo for General MCMC?
  • Quick Example: Polynomial Fitting
  • API Reference
  • Advanced Examples
  • FAQ
  • Summary
• Parallelism and Acceleration Configuration
  • Quick Start
  • Initialization API
  • Multi-Core CPU Parallelism
  • GPU Acceleration
  • Cluster Configuration
  • Environment Variable Configuration
  • Viewing Current Configuration
  • Performance Tuning Tips
  • FAQ
  • Summary
• Configuration-Driven Workflow
  • Parallel Initialization
  • YAML Configuration Example
  • Running a Configuration
• Visualization
  • Visualization Overview
  • Quick Start
  • Plotter Class Interface
  • Multi-Chain Comparison
  • Fisher Forecast Visualization
  • Function Interface
  • Supported Data Formats
  • Style Customization
  • Save Options
  • Complete Examples
  • FAQ
  • Next Steps
• Model Selection and Information Criteria
  • Information Criteria Overview
  • Quick Start
  • Formula Details
  • Handling the Normalization Constant
  • API Reference
  • Complete Examples
  • FAQ
  • Next Steps
• Fisher Forecasts
  • Fisher Matrix Fundamentals
  • Quick Start
  • IntensityMappingFisher Class
  • Survey Configurations
  • 21cm Physics
  • FisherMatrix Class
  • Dark Energy Figure of Merit
  • Growth Parameter Forecasts
  • Visualization
  • Complete Examples
  • Performance Benchmarks
  • FAQ
  • Next Steps
• JAX Numerical Tools Reference
  • Quick Start
  • Integration Tools
  • Differentiation Tools
  • Root-Finding Tools
  • ODE Solvers
  • Cosmology-Specific Tools
  • Performance Comparison
  • JIT Compilation Notes
  • Complete Example
  • References

API Reference

• API Reference
  • High-Level API
  • Models API
  • Likelihoods API
  • Samplers API
  • Parameter System API
  • Configuration Runner API
  • Visualization API
  • Fisher API
  • Utilities API