Skip to content

Installation

We recommend using uv to manage virtual environments for installing gwmock-signal (PyPI distribution name, hyphen) and importing gwmock_signal (underscore) in Python.

After install, continue with the user guide overview, Quick Start, or Command-line interface.

If you don't have uv installed, you can install it with pip. See the project pages for more details:

  • Install via pip: pip install --upgrade pip && pip install uv
  • Project pages: uv on PyPI | uv on GitHub
  • Full documentation and usage guide: uv docs

Requirements

  • Python: 3.12 or 3.13 (requires-python in pyproject.toml is >=3.12,<3.14).
  • Operating system: Linux or macOS (same range as the published wheels and CI).

Python version pin

When creating a virtual environment with uv, pass an explicit interpreter (for example uv venv --python 3.12) so you do not pick an unsupported Python from your machine default.

Install from PyPI

The recommended way to install the library for downstream use is from PyPI:

# Create a virtual environment (recommended with uv)
uv venv --python 3.12
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
uv pip install gwmock-signal

The wheel includes runtime dependencies declared in pyproject.toml: typer, gwpy, lalsuite, pyyaml, and their transitive installs. PyCBC is not a core dependency; install it with the optional extra gwmock-signal[pycbc] when you want the PyCBC waveform backend or the pycbc_waveform_wrapper helper.

There is no gwmock-signal[dev] extra on PyPI; contributor tooling lives in uv dependency groups in the repository (see Install from source).

# Optional waveform backend (PyCBC)
uv pip install 'gwmock-signal[pycbc]'

Install from source

For the latest main branch:

git clone git@github.com:Leuven-Gravity-Institute/gwmock-signal.git
cd gwmock-signal
uv venv --python 3.12
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
uv sync

Development dependencies

From the repository root, install the dev group (pytest, ruff, pre-commit, …):

uv sync --group dev

Documentation build tools (zensical, mkdocstrings-python):

uv sync --group docs

Multiple groups:

uv sync --group dev --group docs

Development setup (full)

Typical contributor workflow:

git clone git@github.com:Leuven-Gravity-Institute/gwmock-signal.git
cd gwmock-signal

uv venv --python 3.12
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
uv sync --group dev

npm ci
uv run pre-commit install
uv run pre-commit install --hook-type commit-msg

Verify installation

gwmock-signal --help
gwmock-signal inject --help

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

Dependencies (direct)

Declared in pyproject.toml for the library:

  • typer — CLI (gwmock-signal entry point)
  • gwpy — TimeSeries / GW I/O conventions
  • lalsuite — default time-domain CBC waveforms (LALSimulation) and related LAL types
  • pyyaml — configuration parsing where used

Optional (pip install 'gwmock-signal[pycbc]'):

  • pycbc — alternate waveform backend (PyCBCBackend) and pycbc_waveform_wrapper

Numerical arrays (numpy, etc.) are pulled in transitively (for example by gwpy and lalsuite).

Getting help

  1. Check the troubleshooting guide
  2. Search existing issues
  3. Open a new issue with your OS, Python version, full traceback, and minimal steps to reproduce