Skip to content

Installation

We recommend using uv to manage virtual environments for installing gwmock-signal (import name gwmock_signal).

After install, continue with the user guide overview or Quick Start.

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 higher
  • Operating System: Linux, macOS, or Windows

Note

The package is built and tested against Python 3.12-3.14. When creating a virtual environment with uv, specify the Python version to ensure compatibility: uv venv --python 3.12 (replace 3.12 with your preferred version in the 3.12-3.14 range). This avoids potential issues with unsupported Python versions.

Install from PyPI

The recommended way to install gwmock_signal 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

Optional Dependencies

For development or specific features:

# Development dependencies (testing, linting, etc.)
uv pip install gwmock-signal[dev]

# Documentation dependencies
uv pip install gwmock-signal[docs]

# All dependencies
uv pip install gwmock-signal[dev,docs]

Install from Source

For the latest development version:

git clone git@github.com:Leuven-Gravity-Institute/gwmock_signal.git
cd gwmock_signal
# Create a virtual environment (recommended with uv)
uv venv --python 3.12
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
uv sync

Development Installation

To set up for development:

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

# Create a virtual environment (recommended with uv)
uv venv --python 3.12
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
uv sync --extra dev

# Install the commitlint dependencies
npm ci

# Install pre-commit hooks
uv run pre-commit install
uv run pre-commit install --hook-type commit-msg

Verify Installation

Check that the package and CLI are available:

gwmock-signal --help

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

Dependencies

Core dependencies

  • numpy: Numerical arrays
  • gwpy: TimeSeries and GW I/O conventions
  • pycbc: Waveforms, detector geometry, and related utilities
  • typer: CLI (gwmock-signal entry point)

Getting Help

  1. Check the troubleshooting guide
  2. Search existing issues
  3. Create a new issue with:
    • Your operating system and Python version
    • Full error message
    • Steps to reproduce the problem