Documentation
Comprehensive documentation for asimov and its ecosystem packages.
Core Projects
asimov
The main framework for managing gravitational-wave parameter estimation analyses across multiple pipelines.
asimov-gwdata
Data handling utilities for gravitational-wave analysis, including data discovery, download, and quality checks.
asimov-gracedb
GraceDB integration for asimov, providing event and superevent lookup without making ligo-gracedb a core dependency of the base package.
Pipeline Interfaces
asimov-pycbc
Interface between asimov and PyCBC for running parameter estimation with PyCBC inference.
asimov-cogwheel
Interface between asimov and cogwheel for efficient likelihood calculations using relative binning.
asimov-bayeswave
Interface between asimov and BayesWave for on-source power spectral density (PSD) estimation.
asimov-lalinference
Interface between asimov and LALInference. Superseded by bilby and RIFT; retained for cross-checks and for replicating older analyses, not for new collaboration parameter estimation.
asimov-pesummary
Interface between asimov and PESummary for post-processing, summarising, and visualising parameter estimation results.
Supported Analysis Pipelines
asimov integrates with several leading gravitational-wave analysis pipelines. Each pipeline has its own comprehensive documentation:
bilby
A Bayesian inference library for gravitational-wave astronomy and beyond.
PyCBC
Python toolkit for analysis of data from gravitational-wave laser interferometer detectors.
cogwheel
Efficient likelihood calculations using relative binning for gravitational-wave parameter estimation.
LALInference
LIGO Algorithm Library inference package for Bayesian parameter estimation.
BayesWave
Bayesian algorithm for detecting and characterizing gravitational-wave signals in noisy data.
API Documentation
Detailed API documentation is automatically generated from the source code for each package. This includes:
- Class and function references
- Parameter descriptions and types
- Return value specifications
- Usage examples
- Cross-references to related components
API documentation is built and hosted through GitHub Actions for each package. Visit the individual package repositories linked above to access their latest API documentation.
Documentation Resources
User Guides
Step-by-step guides for common tasks and workflows. See the Tutorials section.
Examples
Example configurations and analysis scripts demonstrating best practices.
Contributing Guide
Learn how to contribute to asimov and its ecosystem. See the Contributing section.
FAQ
Frequently asked questions and troubleshooting tips (coming soon).
Questions?
If you can't find what you're looking for in the documentation, reach out to the community or open an issue on GitHub.