Skip to content

Quick Start

Welcome to the gwmock-signal documentation.

Before you begin

  1. Follow Installation to create an environment and install the package.
  2. Read the User guide overview for the recommended workflow (waveforms → projection → injection → multichannel).

Verify the install

gwmock-signal --help
python -c "import gwmock_signal; print(gwmock_signal.__version__)"

Next steps

  • Work through User guide → Examples (start with Waveforms).
  • Browse the API overview for full function and class reference.