Skip to content

Installation

We recommend using uv to manage virtual environments for installing gwmock-noise.

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-noise 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-noise

Optional dependencies (extras)

Published wheels expose three optional dependency groups:

Extra Purpose
gwpy GWpy-based helpers (GWpyAdapter, parts of the GWF stack)
frame GWF frame writing (FrameWriter; pulls gwpy and lalsuite)
gengli gengli-backed blip glitches (GengliBlipGlitch)
gwosc Real noise from GWOSC (GwoscNoiseFetcher; pulls gwpy and gwosc) 
uv pip install "gwmock-noise[gwpy]"
uv pip install "gwmock-noise[frame]"
uv pip install "gwmock-noise[gengli]"
uv pip install "gwmock-noise[gwosc]"

Development and documentation tooling are not extras; they live in uv [dependency-groups] in pyproject.toml (dev, docs, build, release). Use uv sync --group dev (and --group docs when building the site) from a git checkout.

Install from Source

For the latest development version:

git clone git@github.com:Leuven-Gravity-Institute/gwmock-noise.git
cd gwmock-noise
# 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 install the package editable with lint/test/doc dependencies:

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

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

uv run prek install

Verify installation

Check that the CLI and import path work:

gwmock-noise --help

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

Core runtime dependencies

The default wheel installs:

  • numpy — arrays, FFTs, RNG
  • h5py — file-backed glitch population tables
  • pydantic — configuration models
  • scipy — signal processing and numerics
  • pyyaml — YAML config loading
  • typer — CLI (gwmock-noise entry point)

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 reproduction steps