Choose Your Path¶

pycWB serves different audiences. Pick the path that matches what you’re trying to do.

Never used pycWB before. Want to understand what it does and run a first search.

Running production searches. Need config templates, cluster submission, and postproduction.

Understanding the physics. Want to know how clustering, likelihood, and ranking work.

Contributing code. Need architecture, setup, module conventions, and performance guides.

Managing releases, CI, reviewing PRs. Need build/test workflows and contribution guidelines.

Not Sure Where to Start?¶

I want to…	Go to…
Run pycWB for the first time ever	Start Here
Understand what each config parameter does	Pipeline Lifecycle (param cross-ref table)
Set up a production search on a cluster	Production Analysis → Run on Clusters
Run an injection campaign	Analysis Recipes → Injection Campaign
Understand how the algorithm works	Core Concepts → Pipeline Lifecycle
Debug a failed run	Analysis Recipes → Debugging a Failed Production
Look up a term	Glossary
Contribute code	Architecture Overview
Find a Python function’s API	modules