Skip to content

Quick Start

This guide will help you run your first gwmock simulation in just a few minutes.

1. Run Your First Simulation

Run the following command in your working directory:

# Copy quick-start configuration file to working directory
gwmock config --get noise/uncorrelated_gaussian/quick_start --output quick_start_config.yaml

# Run simulation
gwmock simulate quick_start_config.yaml

The configuration file quick_start_config.yaml generates a single 1024-second GWF file containing simulated noise data, using the ET_10_full_cryo_psd sensitivity curve from the CoBA Science Study, sampled at 4096 Hz.

You should see output like:

INFO Config mode: quick_start_config.yaml
INFO Configuration loaded and validated: 1 simulators
INFO Created simulation plan from config: 1 batches
INFO Created simulation plan with 1 batches
INFO Validating simulation plan with 1 batches
INFO Simulation plan validation completed successfully
INFO Simulation plan validation passed
INFO Executing simulation plan: 1 batches
INFO Simulation plan validation completed successfully
INFO Executing 1 simulators
Executing simulation plan:   0%|                                        | 0/1
Executing simulation plan: 100%|████████████████████████████████████████| 1/1
INFO All batches completed successfully. Checkpoint files cleaned up.
INFO Simulation completed successfully. Output written to data

2. Check the Output

Your working directory will contain:

output/
└── E-E1-NOISE_STRAIN-1577491218-1024.gwf
metadata/
├── index.yaml
└── noise-0.metadata.yaml

Data File

The GWF file contains the simulated strain data, which can be read using standard gravitational wave analysis software such as GWpy. For a quick guide on reading and working with GWF files, see the Reading Data page.

Metadata File

The metadata file contains everything needed to reproduce this exact simulation. For a quick guide on how to inspect and reuse metadata files to reproduce a dataset, see the Metadata Files page.

3. Explore Different Simulators

To run any gwmock simulations, you only need to provide a .yaml configuration file. A collection of ready-to-use configuration files is available in the gwmock/examples directory. You can use them directly or adapt them to suit your needs.

  • For an overview of all available examples, see the Examples page.
  • For a more complete and user-friendly guide to writing your own configuration files, see the Configuration Files page.

4. Next Steps

  • Generating Data - Quick guide for generating datasets with gwmock, including Einstein Telescope (ET) examples.
  • Examples - Example configuration files for ET simulations.
  • Request New Features - How to request new features or improvements.