README.md

# GWKokab O4a Example Run

This repository provides a minimal working example demonstrating how to perform gravitational-wave population inference with GWKokab, a JAX-based framework for hierarchical Bayesian inference of compact binary populations.

The purpose of this repository is to help new users learn how to run GWKokab through the command-line interface (CLI) by reproducing an O4a population analysis setup. The repository includes example configuration files, scripts, and a complete workflow that can be used as a starting point for custom analyses.

## Contents

- Example GWKokab configuration files
- O4a-style population inference setup
- Command-line execution examples
- Post-processing and plotting scripts

## Quick Start

Run the population inference using the following bash script. It has all the required configs, you can read this file, names are self-explantory.

`./run.sh`

The inference results will be saved in:

`inference_data.hdf5`

Make plots to see the inference using following commnad line. It will create all the diagnostic plots in figs, and `report.html`.

`gwk_report`

To learn about any command line in GWkokab use help for instance `gwk_report -h` or `discrete_subpopulation -h`.

## Purpose

This example is intended as a tutorial and reference workflow for users who want to:

- Learn the GWKokab CLI
- Understand GWKokab configuration files
- Reproduce an O4a-style population analysis
- Build their own population inference studies

## GWKokab

GWKokab is an open-source framework for gravitational-wave population inference, supporting flexible population models for mass, spin, redshift, eccentricity, and multi-source populations.