bispectrum 0.3.0__tar.gz

bispectrum-0.3.0/.gitignore

@@ -0,0 +1,99 @@
+# 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/
+*.egg-info/
+*.egg
+
+# PyInstaller
+*.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
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# ruff
+.ruff_cache/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db
+
+# uv
+uv.lock
+
+# LaTeX build artifacts
+*.aux
+*.log
+*.nav
+*.out
+*.snm
+*.toc
+*.vrb

bispectrum-0.3.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Johan Mathe and the bispectrum authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

bispectrum-0.3.0/PKG-INFO

@@ -0,0 +1,125 @@
+Metadata-Version: 2.4
+Name: bispectrum
+Version: 0.3.0
+Summary: Bispectrum analysis for machine learning
+Project-URL: Homepage, https://github.com/geometric-intelligence/bispectrum
+Project-URL: Repository, https://github.com/geometric-intelligence/bispectrum
+Project-URL: Issues, https://github.com/geometric-intelligence/bispectrum/issues
+Author-email: Johan Mathe <johan.mathe@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: deep learning,machine learning,neural networks,scientific computations,tensor manipulation
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.12
+Requires-Dist: numpy>=1.22.4
+Requires-Dist: torch-harmonics>=0.9
+Requires-Dist: torch>=2.10
+Provides-Extra: dev
+Requires-Dist: mypy>=1.5.0; extra == 'dev'
+Requires-Dist: pre-commit>=3.3.3; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest-xdist>=3.5.0; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.4.0; extra == 'dev'
+Provides-Extra: experiments
+Requires-Dist: h5py; extra == 'experiments'
+Requires-Dist: matplotlib>=3.7.0; extra == 'experiments'
+Requires-Dist: medmnist; extra == 'experiments'
+Requires-Dist: scipy>=1.10; extra == 'experiments'
+Requires-Dist: torchvision; extra == 'experiments'
+Description-Content-Type: text/markdown
+
+# bispectrum
+
+[![Tests](https://github.com/geometric-intelligence/bispectrum/actions/workflows/tests.yml/badge.svg)](https://github.com/geometric-intelligence/bispectrum/actions/workflows/tests.yml)
+[![Pre-commit](https://github.com/geometric-intelligence/bispectrum/actions/workflows/pre-commit.yml/badge.svg)](https://github.com/geometric-intelligence/bispectrum/actions/workflows/pre-commit.yml)
+[![codecov](https://codecov.io/github/geometric-intelligence/bispectrum/graph/badge.svg?token=J6GGY4VK1E)](https://codecov.io/github/geometric-intelligence/bispectrum)
+
+Bispectrum analysis for machine learning.
+
+## Installation
+
+```bash
+pip install bispectrum
+```
+
+Or with [uv](https://github.com/astral-sh/uv):
+
+```bash
+uv pip install bispectrum
+```
+
+### Development
+
+```bash
+git clone https://github.com/geometric-intelligence/bispectrum.git
+cd bispectrum
+uv pip install -e ".[dev]"
+pre-commit install
+```
+
+### Pre-commit Hooks
+
+This project uses [pre-commit](https://pre-commit.com/) for code quality checks. After installing dev dependencies, the hooks run automatically on each commit.
+
+```bash
+# Run hooks on all files (useful for first-time setup or CI)
+pre-commit run --all-files
+
+# Run a specific hook
+pre-commit run ruff --all-files
+
+# Update hooks to latest versions
+pre-commit autoupdate
+```
+
+## Usage
+
+### Cyclic group on itself
+
+```python
+from bispectrum import CnonCn
+
+bsp = CnonCn(n=8)
+f = torch.randn(4, 8)       # signal on Z/8Z
+beta = bsp(f)                # shape (4, 8), complex64
+f_rec = bsp.invert(beta)     # reconstructed up to cyclic shift
+```
+
+### SO(3) on the 2-sphere
+
+```python
+from bispectrum import SO3onS2
+
+# Selective bispectrum: O(L²) entries with generic completeness
+bsp = SO3onS2(lmax=5, nlat=64, nlon=128, selective=True)
+f = torch.randn(1, 64, 128)  # signal on S²
+beta = bsp(f)                 # shape (1, 35), complex64
+
+# Full bispectrum: O(L³) entries
+bsp_full = SO3onS2(lmax=5, nlat=64, nlon=128, selective=False)
+beta_full = bsp_full(f)       # shape (1, 69), complex64
+```
+
+### Octahedral group
+
+```python
+from bispectrum import OctaonOcta
+
+bsp = OctaonOcta()
+f = torch.randn(4, 24)       # signal on O (|O| = 24)
+beta = bsp(f)                 # shape (4, 172), complex64
+f_rec = bsp.invert(beta)      # reconstructed up to group action
+```
+
+See [DESIGN.md](DESIGN.md) for the full API and all supported groups.
+
+## License
+
+MIT

bispectrum-0.3.0/README.md

@@ -0,0 +1,88 @@
+# bispectrum
+
+[![Tests](https://github.com/geometric-intelligence/bispectrum/actions/workflows/tests.yml/badge.svg)](https://github.com/geometric-intelligence/bispectrum/actions/workflows/tests.yml)
+[![Pre-commit](https://github.com/geometric-intelligence/bispectrum/actions/workflows/pre-commit.yml/badge.svg)](https://github.com/geometric-intelligence/bispectrum/actions/workflows/pre-commit.yml)
+[![codecov](https://codecov.io/github/geometric-intelligence/bispectrum/graph/badge.svg?token=J6GGY4VK1E)](https://codecov.io/github/geometric-intelligence/bispectrum)
+
+Bispectrum analysis for machine learning.
+
+## Installation
+
+```bash
+pip install bispectrum
+```
+
+Or with [uv](https://github.com/astral-sh/uv):
+
+```bash
+uv pip install bispectrum
+```
+
+### Development
+
+```bash
+git clone https://github.com/geometric-intelligence/bispectrum.git
+cd bispectrum
+uv pip install -e ".[dev]"
+pre-commit install
+```
+
+### Pre-commit Hooks
+
+This project uses [pre-commit](https://pre-commit.com/) for code quality checks. After installing dev dependencies, the hooks run automatically on each commit.
+
+```bash
+# Run hooks on all files (useful for first-time setup or CI)
+pre-commit run --all-files
+
+# Run a specific hook
+pre-commit run ruff --all-files
+
+# Update hooks to latest versions
+pre-commit autoupdate
+```
+
+## Usage
+
+### Cyclic group on itself
+
+```python
+from bispectrum import CnonCn
+
+bsp = CnonCn(n=8)
+f = torch.randn(4, 8)       # signal on Z/8Z
+beta = bsp(f)                # shape (4, 8), complex64
+f_rec = bsp.invert(beta)     # reconstructed up to cyclic shift
+```
+
+### SO(3) on the 2-sphere
+
+```python
+from bispectrum import SO3onS2
+
+# Selective bispectrum: O(L²) entries with generic completeness
+bsp = SO3onS2(lmax=5, nlat=64, nlon=128, selective=True)
+f = torch.randn(1, 64, 128)  # signal on S²
+beta = bsp(f)                 # shape (1, 35), complex64
+
+# Full bispectrum: O(L³) entries
+bsp_full = SO3onS2(lmax=5, nlat=64, nlon=128, selective=False)
+beta_full = bsp_full(f)       # shape (1, 69), complex64
+```
+
+### Octahedral group
+
+```python
+from bispectrum import OctaonOcta
+
+bsp = OctaonOcta()
+f = torch.randn(4, 24)       # signal on O (|O| = 24)
+beta = bsp(f)                 # shape (4, 172), complex64
+f_rec = bsp.invert(beta)      # reconstructed up to group action
+```
+
+See [DESIGN.md](DESIGN.md) for the full API and all supported groups.
+
+## License
+
+MIT

bispectrum-0.3.0/pyproject.toml

@@ -0,0 +1,114 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/bispectrum"]
+
+[tool.hatch.build.targets.wheel.sources]
+"src" = ""
+
+[tool.hatch.build]
+include = [
+    "src/bispectrum/**/*.py",
+    "src/bispectrum/**/*.json",
+]
+
+[project]
+name = "bispectrum"
+version = "0.3.0"
+description = "Bispectrum analysis for machine learning"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.12"
+authors = [{ name = "Johan Mathe", email = "johan.mathe@gmail.com" }]
+keywords = [
+    "deep learning",
+    "neural networks",
+    "tensor manipulation",
+    "machine learning",
+    "scientific computations",
+]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Science/Research",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: Scientific/Engineering :: Artificial Intelligence",
+]
+
+dependencies = [
+  "torch>=2.10",
+  "numpy>=1.22.4",
+  "torch-harmonics>=0.9",
+]
+
+optional-dependencies.dev = [
+  "pytest>=8",
+  "pytest-cov>=4.0.0",
+  "pytest-xdist>=3.5.0",
+  "ruff>=0.4.0",
+  "mypy>=1.5.0",
+  "pre-commit>=3.3.3",
+]
+optional-dependencies.experiments = [
+  "matplotlib>=3.7.0",
+  "scipy>=1.10",
+  "torchvision",
+  "h5py",
+  "medmnist",
+]
+
+urls.Homepage = "https://github.com/geometric-intelligence/bispectrum"
+urls.Repository = "https://github.com/geometric-intelligence/bispectrum"
+urls.Issues = "https://github.com/geometric-intelligence/bispectrum/issues"
+
+# Pin torch and torchvision to the cu128 wheels so they match systems with
+# NVIDIA driver >= 12.8 (e.g. the local 8x H100 box). PyPI's default torch
+# wheels target a newer CUDA runtime and crash with
+# "NVIDIA driver on your system is too old (found version 12080)".
+[[tool.uv.index]]
+name = "pytorch-cu128"
+url = "https://download.pytorch.org/whl/cu128"
+explicit = true
+
+[tool.uv.sources]
+torch = { index = "pytorch-cu128" }
+torchvision = { index = "pytorch-cu128" }
+
+[tool.ruff]
+target-version = "py312"
+line-length = 120
+src = ["src"]
+
+[tool.ruff.lint]
+select = ["E", "W", "F", "I", "B", "C4", "UP"]
+ignore = ["E501", "B008", "C901", "E741"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.format]
+quote-style = "single"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.mypy]
+python_version = "3.12"
+strict = true
+
+[tool.coverage.run]
+source = ["src/bispectrum"]
+
+[tool.coverage.report]
+exclude_lines = [
+  "pragma: no cover",
+  "if TYPE_CHECKING:",
+  "raise NotImplementedError",
+]

bispectrum-0.3.0/src/bispectrum/__init__.py

@@ -0,0 +1,30 @@
+"""Bispectrum analysis for machine learning."""
+
+from importlib.metadata import PackageNotFoundError
+from importlib.metadata import version as _pkg_version
+
+try:
+    __version__ = _pkg_version('bispectrum')
+except PackageNotFoundError:
+    __version__ = '0.0.0+unknown'
+
+from bispectrum.cn_on_cn import CnonCn
+from bispectrum.dn_on_dn import DnonDn
+from bispectrum.octa_on_octa import OctaonOcta
+from bispectrum.rotation import random_rotation_matrix, rotate_spherical_function
+from bispectrum.so2_on_disk import SO2onDisk
+from bispectrum.so2_on_s1 import SO2onS1
+from bispectrum.so3_on_s2 import SO3onS2
+from bispectrum.torus_on_torus import TorusOnTorus
+
+__all__ = [
+    'CnonCn',
+    'DnonDn',
+    'OctaonOcta',
+    'SO2onDisk',
+    'SO2onS1',
+    'SO3onS2',
+    'TorusOnTorus',
+    'random_rotation_matrix',
+    'rotate_spherical_function',
+]