User Guide
Data Types
API Documentation
Development
On this page
This page provides a comprehensive overview of all the capabilities of asimov-gwdata.
asimov-gwdata
Download gravitational wave strain data from GWOSC
32-second and 4096-second frame files
Multiple detectors: H1, L1, V1
Automatic cache file generation
Support for all observing runs (O1-O4)
Note
The frames download type always retrieves public strain data from GWOSC. Private/proprietary frame access (OSDF/Pelican, scitoken authentication, datafind server lookups) exists in the codebase (datafind.frames.get_data_frames_private()) but is currently only used internally, to retrieve the frame that Virgo’s O4+ calibration uncertainty envelopes are embedded in - it is not yet exposed as a frames download option.
frames
datafind.frames.get_data_frames_private()
See: Accessing strain data for detailed documentation.
Multiple Calibration Sources
Local filesystem (LIGO detectors O2-O4)
Frame files (Virgo O4+)
PESummary metafiles
Automatic observing run detection
Supported Formats
ASCII text files (LIGO format)
Frame-embedded calibration (Virgo)
Bilby-compatible output format
Per-detector version control
Observing Runs
O2: LIGO (H1, L1) and Virgo (V1)
O3a/O3b: LIGO and Virgo
O4a/O4b/O4c: LIGO and Virgo (frame-based)
See: Accessing Calibration Uncertainty Envelopes for detailed documentation.
PESummary Integration
Extract posterior samples from metafiles
Support for multiple analyses per file
Preserves original metafile format
Automatic analysis selection
Use Cases
Reproducing published results
Building on previous analyses
Comparing different waveform models
Ensemble studies
See: Accessing posterior samples for detailed documentation.
PSD Extraction
From PESummary metafiles
Multiple output formats (ASCII, XML)
Per-detector PSD files
Compatible with inference codes
Output Formats
Tab-delimited ASCII (.dat)
.dat
XML format (.xml.gz)
.xml.gz
Bilby-compatible
LALInference-compatible
Data Selection
Specify multiple data types in a single config
Mix and match data sources
Filter by detector, time range, analysis
Time Configuration
GPS time ranges
Frame durations (32s or 4096s)
Automatic time validation
Source Configuration
Local file systems
Frame files
GWOSC public data
See: Configuration Reference for complete reference.
Blueprint-Based Configuration
Seamless integration with asimov
Event-based data retrieval
Conditional logic support
Placeholder substitution
Workflow Features
Automatic job submission
HTCondor integration
Progress tracking
Asset collection
Example Use Cases
Parameter estimation pipelines
Data quality studies
Multi-event analyses
Systematic studies
Standalone Operation
Direct YAML configuration
No asimov required
Quick data retrieval
Scripting support
Example Commands
# Download frames for GW150914 $ gwdata --settings gw150914.yaml # Extract posterior from metafile $ gwdata --settings extract_posterior.yaml
See: Command Line Interface for detailed CLI documentation.
Version-specific calibration handling
Per-detector version specification
Backward compatibility
Automatic version detection
Automatic run identification from GPS time
Run-specific calibration retrieval
Cross-run compatibility
Future-proof design for new runs
Graceful failure modes
Informative error messages
Missing data detection
Validation checks
SciTokens support
SciTokens integration
Automatic credential handling
Secure data access
The tool creates organized output directories:
output/ ├── frames/ # Strain data files ├── cache/ # Frame cache files ├── calibration/ # Calibration envelopes ├── posterior/ # Posterior samples └── psds/ # Power spectral densities
Detector-specific filenames (e.g., H1.dat)
H1.dat
Standard extensions (.gwf, .dat, .h5)
.gwf
.h5
Cache format compatible with LAL
Human-readable organization
Download posterior from official data release
Extract PSDs and calibration from metafile
Use data to reproduce published plots
Compare with independent analyses
Download strain data for event
Retrieve appropriate calibration
Configure inference code
Run parameter estimation
Compare with published results
Download public GWOSC data
Get calibration for observing run
Demonstrate analysis techniques
Educational/outreach purposes
Batch download data for multiple events
Standardized calibration retrieval
Consistent data format
Population analysis ready
Download strain data
Compare multiple analyses
Investigate systematic effects
Validate calibration
H1 (LIGO Hanford)
L1 (LIGO Livingston)
Data Access: GWOSC (public), IGWN (private)
Calibration: Local filesystem (O2-O4)
V1 (Virgo)
O2-O3: Local filesystem
O4+: Frame files
K1 (KAGRA)
Calibration: TBD based on collaboration distribution
O1 (2015-2016): Frames only, no calibration
O2 (2016-2017): Full support
O3a (2019): Full support
O3b (2019-2020): Full support
O4a (2023-2024): Full support
O4b (2024-2025): Full support
O4c (2025): Planned support (dates subject to confirmation)
O1 calibration not available
KAGRA calibration pending
Requires IGWN credentials for private data
Network connectivity required for downloads
HTCondor dependency for asimov integration
Network timeouts for large frame downloads
Version detection edge cases at run boundaries
Depends on network bandwidth
OSDF/Pelican optimized for large files
Parallel downloads not currently supported
4096s frames: ~100MB per detector per file
32s frames: ~1MB per detector per file
Calibration files: <1MB per detector
PSDs: <1MB per detector
Parallel frame downloads
More data validation checks
Additional output formats
Enhanced error recovery
Automated data quality checks
We welcome contributions! See Contributing to asimov-gwdata for guidelines.
📖 Read the Usage Examples
🔧 Check the Configuration Reference reference
💻 Review the API Reference
🐛 Report issues on GitHub
💬 Ask questions in discussions
This documentation was automatically generated with GitHub Copilot to provide comprehensive coverage of all package functionality.