gwmock-benchmark 0.2.0__tar.gz

gwmock_benchmark-0.2.0/.coderabbit.yaml

@@ -0,0 +1,3 @@
+reviews:
+    auto_review:
+        enabled: false

gwmock_benchmark-0.2.0/.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,56 @@
+---
+name: 🐛 Bug Report
+about: Create a report to help us improve
+title: '[BUG]: '
+labels: bug
+assignees: ''
+---
+
+## 📝 Description
+
+A clear and concise description of what the bug is.
+
+## 🚀 Reproduction Steps
+
+Steps to reproduce the behavior:
+
+1. '...'
+2. '...'
+3. '...'
+
+## 💻 Minimal Reproducible Example
+
+Please provide a short snippet of Python code that demonstrates the issue. Use
+code blocks for readability:
+
+```python
+# Your code here
+```
+
+## 📋 Expected Behavior
+
+A clear and concise description of what you expected to happen.
+
+## 💥 Actual Behavior / Traceback
+
+If applicable, add the Python error traceback here **after redacting secrets**
+(API keys, tokens, credentials, private URLs/paths, personal data). If this is a
+potential security vulnerability, do **not** post it publicly; use the Security
+reporting channel instead.
+
+```text
+Traceback (most recent call last):
+  ...
+
+```
+
+## 🛠 Environment Information
+
+- **Python Version:** (e.g., 3.12)
+- **Package Version:** (e.g., 1.2.3)
+- **Operating System:** (e.g., Windows 11, Ubuntu 22.04, macOS)
+- **Relevant Dependencies:** (e.g., numpy, pandas version if applicable)
+
+## 📎 Additional Context
+
+Add any other context about the problem here (e.g., screenshots, logs).

gwmock_benchmark-0.2.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+    - name: GitHub Community Support
+      url: https://github.com/Leuven-Gravity-Institute/gwmock-benchmark/discussions
+      about: Please ask and answer questions here.

gwmock_benchmark-0.2.0/.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,47 @@
+---
+name: ✨ Feature Request
+about: Suggest an idea or improvement for this package
+title: '[FEATURE]: '
+labels: enhancement
+assignees: ''
+---
+
+## 🎯 Problem Statement
+
+Is your feature request related to a problem? Please describe.
+
+> _Ex: "I'm always frustrated when I have to manually loop over X to achieve
+> Y..."_
+
+## 💡 Proposed Solution
+
+A clear and concise description of what you want to happen. Describe the new
+functionality or the change to existing behavior.
+
+## 💻 Proposed API / Usage Example
+
+If applicable, show how you would imagine the Python code looking with this new
+feature:
+
+```python
+import gwsim_benchmark
+
+# How you'd like to use the new feature
+result = gwsim_benchmark.new_function(param="example")
+
+```
+
+## 🌈 Use Case & Benefits
+
+Why is this feature important to you and other users? How does it improve the
+package?
+
+## 🔄 Alternatives Considered
+
+A clear and concise description of any alternative solutions or workarounds
+you've considered (e.g., using a different library or a custom wrapper).
+
+## ⚠️ Additional Context
+
+Add any other context, screenshots, or links to similar implementations in other
+libraries here.

gwmock_benchmark-0.2.0/.github/pull_request_template.md

@@ -0,0 +1,40 @@
+---
+name: 🚀 Pull Request
+about: Submit your changes for review
+---
+
+## 📝 Summary
+
+Briefly describe the changes introduced by this PR. Mention any related issues
+using keywords (e.g., `Closes #123`).
+
+## ✨ Type of Change
+
+- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
+- [ ] ✨ New feature (non-breaking change which adds functionality)
+- [ ] 💥 Breaking change (fix or feature that would cause existing functionality
+      to not work as expected)
+- [ ] 📝 Documentation update
+- [ ] 🎨 Refactoring (no functional changes, no API changes)
+
+## 🧪 How Has This Been Tested?
+
+Please describe the tests that you ran to verify your changes.
+
+- [ ] **Unit Tests:** `uv run pytest tests/test_feature.py`
+- [ ] **Manual Test:** (Describe steps)
+
+## 🏗️ Checklist
+
+- [ ] My code follows the style guidelines of this project (PEP 8).
+- [ ] I have performed a self-review of my own code.
+- [ ] I have commented my code, particularly in hard-to-understand areas.
+- [ ] I have made corresponding changes to the documentation.
+- [ ] My changes generate no new warnings.
+- [ ] I have added tests that prove my fix is effective or that my feature
+      works.
+
+## 📷 Screenshots (if applicable)
+
+If this is a UI change or produces a specific output/graph, add screenshots
+here.

gwmock_benchmark-0.2.0/.github/workflows/ci.yml

@@ -0,0 +1,81 @@
+name: CI
+on:
+    push:
+        branches: [main]
+    pull_request:
+        branches: [main]
+    workflow_dispatch:
+    workflow_call:
+
+jobs:
+    test:
+        strategy:
+            matrix:
+                python-version: ['3.12', '3.13', '3.14']
+                # HPC benchmarking tool: Unix-only deps (resource, /proc, nvidia-smi,
+                # SLURM/HTCondor, lalsuite). Windows is not a supported runtime.
+                os: [ubuntu-latest, macos-latest]
+        runs-on: ${{ matrix.os }}
+        steps:
+            - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+
+            - name: Install uv
+              uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7
+              with:
+                  python-version: ${{ matrix.python-version }}
+                  enable-cache: 'true'
+
+            - name: Install dependencies
+              run: uv sync --group dev --frozen
+
+            - name: Run tests with pytest
+              run: uv run --frozen pytest
+
+            - name: Upload coverage to Codecov
+              if: ${{ !cancelled() }}
+              uses: codecov/codecov-action@0fb7174895f61a3b6b78fc075e0cd60383518dac # v5
+              with:
+                  token: ${{ secrets.CODECOV_TOKEN }}
+
+    # Gate on contributed data: every record under data/ must be well-formed, have
+    # complete provenance, and have derived metrics that still agree with the
+    # primitives they were computed from. Catches malformed or hand-edited records on
+    # the PR that adds them. Pure arithmetic — no waveform extras needed.
+    validate-data:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+
+            - name: Install uv
+              uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7
+              with:
+                  python-version: '3.13'
+                  enable-cache: 'true'
+
+            - name: Install dependencies
+              run: uv sync --frozen
+
+            - name: Validate committed records
+              run: uv run --frozen gwmock-benchmark validate --data-dir data
+
+    # Exercises the gwmock-signal suite end to end: installs the [signal] extra
+    # (gwmock-signal[jax,pycbc] -> lalsuite, jax, ripplegw, pycbc) and runs the
+    # integration tests that actually generate waveforms.
+    test-signal:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+
+            - name: Install uv
+              uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7
+              with:
+                  python-version: '3.13'
+                  enable-cache: 'true'
+
+            - name: Install dependencies (with signal extra)
+              run: uv sync --group dev --extra signal --frozen
+
+            - name: Run signal suite integration tests
+              run:
+                  uv run --frozen pytest -m integration
+                  tests/suites/test_signal.py

gwmock_benchmark-0.2.0/.github/workflows/codeql.yml

@@ -0,0 +1,34 @@
+name: 'CodeQL Advanced'
+
+on:
+    push:
+        branches: ['main']
+    pull_request:
+        branches: ['main']
+    schedule:
+        - cron: '0 0 * * 1'
+    workflow_call:
+
+jobs:
+    analyze:
+        name: Analyze
+        runs-on: ubuntu-latest
+        permissions:
+            security-events: write
+            actions: read
+            contents: read
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+
+            - name: Initialize CodeQL
+              uses: github/codeql-action/init@8aad20d150bbac5944a9f9d289da16a4b0d87c1e # v4
+              with:
+                  languages: python
+                  queries: security-and-quality
+
+            - name: Autobuild
+              uses: github/codeql-action/autobuild@8aad20d150bbac5944a9f9d289da16a4b0d87c1e # v4
+
+            - name: Perform CodeQL Analysis
+              uses: github/codeql-action/analyze@8aad20d150bbac5944a9f9d289da16a4b0d87c1e # v4

gwmock_benchmark-0.2.0/.github/workflows/documentation.yml

@@ -0,0 +1,49 @@
+name: Documentation
+
+on:
+    push:
+        branches: [main]
+    workflow_dispatch:
+
+permissions:
+    contents: read
+    pages: write
+    id-token: write
+
+concurrency:
+    group: pages
+    cancel-in-progress: false
+
+jobs:
+    deploy:
+        runs-on: ubuntu-latest
+        environment:
+            name: github-pages
+            url: ${{ steps.deployment.outputs.page_url }}
+        steps:
+            - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+
+            - name: Install uv
+              uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7
+              with:
+                  python-version: '3.14.3'
+                  enable-cache: 'true'
+
+            - name: Install dependencies
+              run: uv sync --group docs --frozen
+
+            # Render figures + table snippets from the committed data/ before building
+            # (zensical has no in-renderer hook); contributors submit data only.
+            - name: Aggregate benchmark data into the docs
+              run:
+                  uv run --frozen gwmock-benchmark aggregate --data-dir data
+                  --docs-dir docs
+
+            - run: uv run --frozen zensical build
+
+            - uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4
+              with:
+                  path: site
+
+            - id: deployment
+              uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4

gwmock_benchmark-0.2.0/.github/workflows/draft_release.yml

@@ -0,0 +1,50 @@
+name: Draft Release
+
+on:
+    push:
+        branches: [main]
+
+permissions:
+    contents: write
+    pull-requests: read
+
+concurrency:
+    group: draft-release
+    cancel-in-progress: true
+
+jobs:
+    draft-release:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+              with:
+                  fetch-depth: 0
+
+            - name: Generate changelog
+              id: changelog
+              uses: orhun/git-cliff-action@f50e11560dce63f7c33227798f90b924471a88b5 # v4.8.0
+              with:
+                  config: cliff.toml
+                  args: --unreleased --verbose
+              env:
+                  OUTPUT: CHANGELOG.md
+
+            - name: Delete existing draft release
+              continue-on-error: true
+              run: |
+                  gh release delete next-release --yes
+              env:
+                  GH_TOKEN: ${{ github.token }}
+
+            - name: Create or Update Draft Release
+              uses: softprops/action-gh-release@3bb12739c298aeb8a4eeaf626c5b8d85266b0e65 # v2
+              with:
+                  tag_name: next-release
+                  name: 'Next Release (Draft)'
+                  body: |
+                      ${{ steps.changelog.outputs.content }}
+
+                      ---
+                      *This is an automatically generated draft release.*
+                  draft: true
+                  prerelease: false

gwmock_benchmark-0.2.0/.github/workflows/publish.yml

@@ -0,0 +1,70 @@
+name: Publish to PyPI
+
+on:
+    workflow_dispatch:
+        inputs:
+            tag_name:
+                description: 'Tag name for the publish (e.g., v1.2.3)'
+                required: true
+                type: string
+    workflow_call:
+        inputs:
+            tag_name:
+                description: 'Tag name for the publish (e.g., v1.2.3)'
+                required: true
+                type: string
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+              with:
+                  ref: ${{ inputs.tag_name || github.event.inputs.tag_name }}
+                  fetch-depth: 0
+
+            - name: Output build information
+              run: |
+                  echo "### Publishing Build :package:" >> $GITHUB_STEP_SUMMARY
+                  echo "- **Version tag**: ${{ inputs.tag_name || github.event.inputs.tag_name }}" >> $GITHUB_STEP_SUMMARY
+
+            - name: Install uv
+              uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7
+              with:
+                  python-version: '3.14.3'
+                  enable-cache: 'true'
+
+            - name: Install dependencies
+              run: uv sync --frozen
+
+            - name: Build distribution
+              run: uv build
+
+            - name: Upload build artifacts
+              uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6
+              with:
+                  name: python-package-distributions
+                  path: dist/
+
+    publish-to-pypi:
+        needs: build
+        runs-on: ubuntu-latest
+        environment: pypi
+        permissions:
+            id-token: write
+
+        steps:
+            - name: Download build artifacts
+              uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7
+              with:
+                  name: python-package-distributions
+                  path: dist/
+
+            - name: Publish to PyPI
+              uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # v1.14.0
+              # Remove this line if you want the workflow to fail on publish errors
+              # This is added for this template only since the environment 'pypi' is
+              # not created to avoid publishing
+              continue-on-error: true
+              with:
+                  packages-dir: dist/

gwmock_benchmark-0.2.0/.github/workflows/publish_testpypi.yml

@@ -0,0 +1,84 @@
+name: Publish to TestPyPI
+
+on:
+    push:
+        branches:
+            - main
+    workflow_dispatch:
+        inputs:
+            tag_name:
+                description: 'Tag name for the publish (e.g., v1.2.3)'
+                required: false
+                type: string
+    workflow_call:
+        inputs:
+            tag_name:
+                description: 'Tag name for the publish (e.g., v1.2.3)'
+                required: false
+                type: string
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+              with:
+                  ref: ${{ inputs.tag_name || github.sha }}
+                  fetch-depth: 0
+
+            - name: Output build information
+              run: |
+                  echo "### Publishing Build :package:" >> $GITHUB_STEP_SUMMARY
+                  echo "- **Version tag**: ${{ inputs.tag_name || github.sha }}" >> $GITHUB_STEP_SUMMARY
+
+            - name: Install uv
+              uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7
+              with:
+                  python-version: '3.14.3'
+                  enable-cache: 'true'
+
+            - name: Install dependencies
+              run: uv sync --group build --frozen
+
+            - name: Set version for publishing
+              run: |
+                  if [ -n "${{ inputs.tag_name }}" ]; then
+                    # Use the tag, stripping 'v' prefix if present
+                    VERSION=$(echo "${{ inputs.tag_name }}" | sed 's/^v//')
+                  else
+                    # For untagged builds, use a dev version without local part
+                    # Get the dev version from hatch-vcs, then strip +local
+                    VERSION=$(uv run --frozen hatch version | sed 's/+.*//')
+                  fi
+
+                  # Update pyproject.toml with sed
+                  sed -i "s/dynamic = \[\"version\"\]/version = \"$VERSION\"\ndynamic = []/" pyproject.toml
+
+            - name: Build distribution
+              run: uv build
+
+            - name: Upload build artifacts
+              uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6
+              with:
+                  name: python-package-distributions
+                  path: dist/
+
+    publish-to-testpypi:
+        needs: build
+        runs-on: ubuntu-latest
+        environment: testpypi
+        permissions:
+            id-token: write
+
+        steps:
+            - name: Download build artifacts
+              uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7
+              with:
+                  name: python-package-distributions
+                  path: dist/
+
+            - name: Publish to TestPyPI
+              uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # v1.14.0
+              with:
+                  repository-url: https://test.pypi.org/legacy/
+                  packages-dir: dist/

gwmock_benchmark-0.2.0/.github/workflows/release.yml

@@ -0,0 +1,58 @@
+name: Release
+
+on:
+    workflow_dispatch:
+        inputs:
+            tag_name:
+                description: 'Tag name for the release (e.g., v1.2.3)'
+                required: true
+                type: string
+    workflow_call:
+        inputs:
+            tag_name:
+                description: 'Tag name for the release (e.g., v1.2.3)'
+                required: true
+                type: string
+
+permissions:
+    contents: write
+
+jobs:
+    release:
+        runs-on: ubuntu-latest
+        permissions:
+            contents: write
+        steps:
+            - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+              with:
+                  fetch-depth: 0
+                  ref: ${{ inputs.tag_name || github.event.inputs.tag_name }}
+
+            - name: Generate changelog
+              id: changelog
+              uses: orhun/git-cliff-action@f50e11560dce63f7c33227798f90b924471a88b5 # v4.8.0
+              with:
+                  config: cliff.toml
+                  args: --current --verbose
+              env:
+                  OUTPUT: CHANGELOG.md
+
+            - name: Delete draft release
+              continue-on-error: true
+              run: |
+                  gh release delete next-release --yes
+              env:
+                  GH_TOKEN: ${{ github.token }}
+
+            - name: Create Release
+              uses: softprops/action-gh-release@3bb12739c298aeb8a4eeaf626c5b8d85266b0e65 # v2
+              with:
+                  tag_name:
+                      ${{ inputs.tag_name || github.event.inputs.tag_name }}
+                  body: ${{ steps.changelog.outputs.content }}
+                  draft: false
+                  prerelease:
+                      ${{ contains(inputs.tag_name ||
+                      github.event.inputs.tag_name, 'alpha') ||
+                      contains(inputs.tag_name || github.event.inputs.tag_name,
+                      'beta') }}