Documentation
Comprehensive documentation for asimov and its ecosystem packages.
Core Framework
asimov
Workflow infrastructure for automated, recorded and reproducible scientific analysis.
Plugins
Extend asimov with plugins for analysis pipelines, data handling, and more:
Parameter estimation
| Plugin | Description | Documentation |
|---|---|---|
| RIFT | Rapid iterative fitting for gravitational-wave parameter estimation; ships its own asimov integration. | README |
| asimov-cogwheel | An asimov interface to the cogwheel parameter estimation code. | Docs |
| asimov-jim | Allow asimov to interface with [Jim](https://github.com/GW-JAX-Team/Jim) | README |
| asimov-lalinference | LALInference pipeline integration for Asimov | Docs |
| asimov-pycbc | A pycbc-inference pipeline integration for asimov | README |
| asimov-simplepe | Allowing asimov to interact with simple-pe | Docs |
| bilby_pipe | Bilby's pipeline for gravitational-wave parameter estimation; ships its own asimov integration. | Docs |
Data & noise characterisation
| Plugin | Description | Documentation |
|---|---|---|
| asimov-bayeswave | BayesWave pipeline integration for Asimov | Docs |
| asimov-gwdata | An asimov plugin to make downloading gravitational wave data easier | Docs |
| asimov-ptadata | Pulsar timing array data acquisition and reduction, with an Asimov pipeline plugin | README |
| asimov-pyomicron | An interface between asimov and the pyomicron package | README |
Searches & burst analyses
| Plugin | Description | Documentation |
|---|---|---|
| asimov-pycwb | A pycwb plugin for asimov | README |
Post-processing & results
| Plugin | Description | Documentation |
|---|---|---|
| asimov-pesummary | PESummary pipeline integration for Asimov | Docs |
Simulation & injections
| Plugin | Description | Documentation |
|---|---|---|
| minke | A package to make generating gravitational waveforms easier. | README |
Services & integrations
| Plugin | Description | Documentation |
|---|---|---|
| asimov-gracedb | GraceDB integration for Asimov | README |
Beyond gravitational waves
| Plugin | Description | Documentation |
|---|---|---|
| asimov-exoplanet | An asimov experiment with exoplanet data | README |
Guides in the asimov documentation
The asimov documentation is the reference for the core package. Good starting points:
- Getting startedinstall asimov and set up a project
- Blueprintsthe YAML format for projects, subjects and analyses, and how settings cascade
- The ledgerwhere asimov records every analysis and its state
- Clusters and schedulersrunning on HTCondor and Slurm
- Monitoringhow asimov tracks jobs and recovers from failures
- Hooksextending asimov with post-monitor, applicator and file-source hooks
- API referencethe Python API, generated from the source
For worked examples, see the tutorials. To contribute to asimov or list a plugin, see contributing.
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.