gwmock-noise 0.1.0

A Python package for simulating instrumental noise.

gwmock-noise

A Python package for simulating gravitational wave detector noise.

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

Install from Source

For the latest development version:

git clone [e-mail]: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 set up for development:

git clone [e-mail]: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 --group dev

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

Verify Installation

Check that gwmock-noise is installed correctly:

gwmock-noise --help

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

Documentation

Full documentation to be available at https://leuven-gravity-institute.github.io/gwmock_noise.

Contributing

Contributions are welcome!

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests
5. Submit a pull request

Release Schedule

Releases follow a fixed schedule: every Tuesday at 00:00 UTC, unless an emergent bugfix is required. This ensures predictable updates while allowing flexibility for critical issues. Users can view upcoming changes in the draft release on the GitHub Releases page.

Testing

Run the test suite:

uv run pytest

License

This project is licensed under the 3-Clause BSD License - see the LICENSE file for details.

Support

For questions or issues, please open an issue on GitHub or contact the maintainers.