quatham 0.2.0rc0__tar.gz

quatham-0.2.0rc0/.codecov.yml

@@ -0,0 +1,32 @@
+# Codecov Configuration
+# See: https://docs.codecov.com/docs/codecov-yaml
+
+codecov:
+  require_ci_to_pass: true
+  notify:
+    after_n_builds: 1  # Wait for all Python versions to complete
+
+coverage:
+  status:
+    project:
+      default:
+        # Allow a small drop in coverage
+        threshold: 1%
+        target: auto  # Auto-adjusts based on historical coverage
+        if_ci_failed: error
+    
+    patch:
+      default:
+        # New code should be well-tested
+        target: 80%
+        threshold: 5%
+
+comment:
+  layout: "header, diff, flags, components"
+  behavior: default
+  require_changes: false  # Comment even if no changes (good for visibility)
+
+ignore:
+  - "tests/**"
+  - "docs/**"
+  - "site/**"

quatham-0.2.0rc0/.github/workflows/docs.yml

@@ -0,0 +1,64 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+      - 'src/quatham/**'
+      - 'mkdocs.yml'
+      - 'README.md'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: |
+          uv sync --group docs
+
+      - name: Build documentation
+        run: uv run zensical build
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './site'
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

quatham-0.2.0rc0/.github/workflows/release.yml

@@ -0,0 +1,44 @@
+name: Release to PyPI
+
+on:
+  push:
+    tags:
+      - '*'  # Trigger on any tag
+
+permissions:
+  contents: read
+  id-token: write  # Required for trusted publishing to PyPI
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/quatham/
+    
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Get all history for hatch-vcs
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies
+        run: uv sync --group dev
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          verbose: true

quatham-0.2.0rc0/.github/workflows/tests.yml

@@ -0,0 +1,48 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.12', '3.13', '3.14']
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 2
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --group tests
+
+      - name: Test with pytest
+        run: |
+          uv run pytest --cov=src/quatham --cov-report=xml --junitxml=junit.xml -o junit_family=legacy
+
+      - name: Upload coverage and tests to Codecov
+        uses: codecov/codecov-action@v5
+        if: always()
+        with:
+          files: ./coverage.xml,./junit.xml
+          flags: python-${{ matrix.python-version }}
+          verbose: true

quatham-0.2.0rc0/.gitignore

@@ -0,0 +1,306 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+site/
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### PyCharm ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# Just ignore all pycharm files
+.idea/**
+.ai/**
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### PyCharm Patch ###
+# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
+
+# *.iml
+modules.xml
+.idea/misc.xml
+# *.ipr
+
+# Sonarlint plugin
+# https://plugins.jetbrains.com/plugin/7973-sonarlint
+.idea/**/sonarlint/
+
+# SonarQube Plugin
+# https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin
+.idea/**/sonarIssues.xml
+
+# Markdown Navigator plugin
+# https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced
+.idea/**/markdown-navigator.xml
+.idea/**/markdown-navigator-enh.xml
+.idea/**/markdown-navigator/
+
+# Cache file creation bug
+# See https://youtrack.jetbrains.com/issue/JBR-2257
+.idea/$CACHE_FILE$
+
+# CodeStream plugin
+# https://plugins.jetbrains.com/plugin/12206-codestream
+.idea/codestream.xml
+
+### vscode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+*.code-workspace
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# VTK files
+*.vtk
+*.vti
+*.vtr
+*.vts
+*.vtp
+*.vtu
+*.vtm
+*.vtkhdf
+
+# Images
+*.jpg
+*.png
+
+# D2C data
+*.h5
+*.hdf
+*.hdf5
+*.pkl

quatham-0.2.0rc0/.gitlab-ci.yml

@@ -0,0 +1,16 @@
+# You can override the included template(s) by including variable overrides
+# SAST customization: https://docs.gitlab.com/user/application_security/sast/#available-cicd-variables
+# Secret Detection customization: https://docs.gitlab.com/user/application_security/secret_detection/pipeline/configure/
+# Dependency Scanning customization: https://docs.gitlab.com/user/application_security/dependency_scanning/#customizing-analyzer-behavior
+# Container Scanning customization: https://docs.gitlab.com/user/application_security/container_scanning/#customizing-analyzer-behavior
+# Note that environment variables can be set in several places
+# See https://docs.gitlab.com/ci/variables/#cicd-variable-precedence
+stages:
+- test
+- secret-detection
+variables:
+  SECRET_DETECTION_ENABLED: 'true'
+secret_detection:
+  stage: secret-detection
+include:
+- template: Security/Secret-Detection.gitlab-ci.yml

quatham-0.2.0rc0/AGENTS.md

@@ -0,0 +1,123 @@
+# AGENTS.md
+
+## Project Overview
+- **Package**: `quatham` (import as `hammy`) — NumPy/Numba-accelerated quaternion mathematics for 3D rotations
+- **Structure**: Single-package layout under `src/quatham/`
+- **Python**: 3.12+
+- **Package manager**: `uv` (lockfile: `uv.lock`)
+
+## Developer Commands
+
+```bash
+# Install dependencies
+uv sync
+
+# Run all tests
+uv run pytest
+
+# Run tests with coverage
+uv run pytest --cov=hammy
+
+# Run a single test file
+uv run pytest tests/test_algebra.py
+
+# Run a specific test
+uv run pytest tests/test_algebra.py::TestQuaternionAlgebra::test_identity_and_conjugate
+
+# Lint with ruff
+uv run ruff check src/ tests/
+
+# Format with ruff
+uv run ruff format src/ tests/
+```
+
+## Architecture Notes
+
+### Source Files
+- `src/quatham/Quaternion.py` — Main `Quaternion` class with algebraic operations and conversions
+- `src/quatham/utilities.py` — Low-level Numba-jitted math functions (`@njit(cache=True)`)
+- `src/quatham/__init__.py` — Exports `Quaternion` class
+
+### Test Files
+- `tests/test_algebra.py` — Quaternion algebra, normalization, arithmetic operations
+- `tests/test_conversions.py` — Euler/Tait-Bryan angle conversions, rotation matrices, axis-angle
+
+### Key Conventions (critical for correctness)
+- **Scalar-first**: Quaternions use `[w, x, y, z]` ordering throughout
+- **Intrinsic rotations**: Default for `from_euler()`, `to_euler()`, `to_tait_bryan()`
+- **Double-cover SO(3)**: `q` and `-q` represent identical spatial rotations
+- **Batch support**: All operations handle single quaternions `(4,)` and arrays `(N, 4)`
+
+### Numba Functions
+- Utilities use `@njit(cache=True)` — changes may require clearing `__pycache__` or `.ruff_cache/` to see effects during development
+
+
+## Lint/Format Rules (ruff)
+Maintain PEP 8 compliance. Recommended tools:
+
+- **Linting:** `ruff check dice.py`
+- **Formatting:** `ruff format dice.py`
+- Line length: 120
+- Select: E, F, UP, B, SIM, I, D (pydocstyle numpy convention)
+- Ignore: D103 (missing docstring in __init__)
+
+## Code Style Guidelines
+### General Principles
+- **Simplicity:** Keep the logic straightforward. Avoid over-engineering for a single-file utility.
+- **Readability:** Prioritize clear, descriptive names over brevity.
+
+### Naming Conventions
+- **Functions:** Use `snake_case` (e.g., `generate_dice_faces_diagram`).
+- **Variables:** Use `snake_case` (e.g., `roll_results`).
+- **Constants:** Use `SCREAMING_SNAKE_CASE` (e.g., `DICE_ART`, `DIE_HEIGHT`).
+- **Internal Helpers:** Prefix with a single underscore (e.g., `_get_dice_faces`).
+
+### Imports
+- Place standard library imports at the top of the file.
+- Keep them alphabetised within their group.
+- Example:
+  ```python
+  import random
+  import sys
+  ```
+
+### Documentation Guidelines
+- Use triple-quoted docstrings for all functions.
+- The first line should be a concise summary.
+- Follow with a more detailed explanation if the function's logic or parameters aren't trivial.
+- Use NumPy style docstrings. Add details for extended summary, parameters, yields, returns and examples where appropriate.
+- Example:
+  ```python
+  def roll_dice(num_dice):
+      """Return a list of random integers between 1 and 6.
+      
+      Parameters
+      ----------
+      num_dice : int
+          Number of dice to be rolled.
+      """
+      # Implementation
+  ```
+
+### Language
+- Use British English spelling throughout the codebase.
+- Applies to: comments, docstrings, documentation, error messages, and variable names.
+- Examples: `colour` not `color`, `analyse` not `analyze`, `behaviour` not `behavior`.
+
+## Git Workflow
+- Do not commit, push, merge, or force-push without approval.
+- Do not include unrelated formatting changes.
+- Keep migrations and generated files in the same change as the code that requires them.
+- Summarise user-visible behaviour and validation in the pull request.
+
+## Python Guidelines
+- Follow PEP 8 style conventions
+- Add type hints to all new and modified functions
+- Prefer specific exception types over bare `except` clauses
+- Use context managers for file I/O and database connections
+- Write descriptive error messages that include the offending value
+- Keep user comments when refactoring or modifying code. Reposition if necessary, but they were put there for a reason.
+
+## CI/CD
+- GitLab CI (`.gitlab-ci.yml`): Runs pytest + secret detection
+- No GitHub Actions configured