flux-hopf-lib 0.1.0

Shared core library for Hopf fibrations, quaternions, gauged flux lattices, conduits, and survival/relaxation probes

flux_hopf_lib

Shared core library for the Hopf / flux / quaternion / conduit ecosystem (kinaar8340).

Version: 0.1.0 · Role: single source of truth for foundational math.

Specialized experiments, Gradio portals, and full model stacks stay in consumer repos. Consumers depend on this package, not on each other, for shared primitives.

Dependency direction

                    flux_hopf_lib  (core / SoT)
                           │
     ┌─────────┬───────────┼───────────┬──────────┬────────────┐
     ▼         ▼           ▼           ▼          ▼            ▼
  mystery     toe      vqc_proto      hfb     kingdom   vqc_sims_public
   HF ✓                HF ✓         HF ✓     HF ✓      (parent OAM suite)

• Allowed: from flux_hopf_lib…, optional sibling imports of specialized models only.
• Forbidden: sys.path into ../toe for survival/κ math; copy-pasted R residual / Hopf maps.

See docs/DEPENDENCIES.md and docs/ECOSYSTEM.md.

Install

# Editable (local ecosystem development)
cd ~/Projects/flux_hopf_lib
python -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"

# Optional torch quaternion helpers
pip install -e ".[torch]"

Consumer repos:

pip install -e ../flux_hopf_lib
# or pin a release tag:
# pip install "flux-hopf-lib @ git+https://github.com/kinaar8340/flux_hopf_lib.git@v0.1.0"

# requirements.txt / HF Space (git pin — works today)
flux-hopf-lib @ git+https://github.com/kinaar8340/flux_hopf_lib.git@v0.1.0

# After PyPI Trusted Publishing is live:
# flux-hopf-lib==0.1.0

Publishing: docs/PUBLISHING.md · CHANGELOG.md

Recommended import style

Keep the namespace flat and predictable:

from flux_hopf_lib import PHI, R_RESIDUAL, E_INV2, DEFAULT_KAPPA
from flux_hopf_lib.quaternion import Quaternion, small_rotor, q_mult
from flux_hopf_lib.hopf import hopf_map, hopf_map_from_angles, toroidal_hopfion_director
from flux_hopf_lib.flux import FluxLatticeConfig, FluxFlywheel, gaussian_defect
from flux_hopf_lib.simulation import (
    steps_for_lambda_t,
    evolve_gauged_twist_survival,
    simulate_twist_pde_survival,
    compare_to_analogs,
)
from flux_hopf_lib.conduit import (
    ConduitConfig,
    GoldenAngleMixin,
    GaugePointerMixin,
    apply_golden_angle_increment,
)
from flux_hopf_lib.utils import cartesian_grid, laplacian_fft

Leaf repos may keep thin re-export shims for one release cycle (toe.relaxation_survival, hfb.hopf, orbital_braille.quaternion_codec) so old imports keep working while you migrate.

Package layout

src/flux_hopf_lib/
  constants.py          # φ, e, π, R residual, κ defaults, W_g lock
  quaternion/           # Quaternion, q_mult, rotors, encode_shard (+ torch_ops)
  hopf/                 # Hopf map, linking, hopfion directors
  flux/                 # FluxLatticeConfig, gauge steps, defect densities
  simulation/           # λt normalization, survival, twist PDE, κ sweeps
  conduit/              # ConduitConfig, GoldenAngleMixin, GaugePointerMixin
  utils/                # cartesian/polar grids, FFT Laplacian
examples/
  quickstart.py
  consumer_mixin_pattern.py

Quick start

python examples/quickstart.py

from flux_hopf_lib.simulation import steps_for_lambda_t, evolve_gauged_twist_survival

n = steps_for_lambda_t(lambda_t_target=2.0, kappa=0.85, dt=0.001)
out = evolve_gauged_twist_survival(n_steps=n, n_identities=32, seed=42)
print(out["identity_survival"])

What belongs where

In flux_hopf_lib (core)	In leaf repos
Quaternion / Rodrigues	Full RubikConeConduit + training (toe)
Hopf maps, hopfions, linking	VQC/OAM encoding, ICA demixing (vqc_*)
Flux lattice / gauge / defects	Analog-gravity / warp solvers (hfb)
λt survival, twist PDE, κ sweeps	Gradio / Streamlit UIs (kingdom, HF Spaces)
ConduitConfig + mixins	HF Space storytelling, papers, Ray demos
Grids / FFT Laplacian

Migration status

Repo	Status
mystery	✓ flux_hopf_lib.simulation (no toe path hacks for survival)
toe	✓ relaxation_survival shim; golden-angle + GaugePointerMixin
vqc_proto	✓ Quaternion codec re-export
vqc_sims_public	✓ quaternion_core re-export
hfb	✓ hopf / grid / defect shims
kingdom	✓ constants + hopf + quaternion for portal demos

Details: docs/MIGRATION.md.

Development workflow

1. Change foundational math only in this repo.
2. Run pytest and python examples/quickstart.py.
3. Update CHANGELOG.md; bump version in pyproject.toml + __init__.py.
4. Tag a release (v0.1.x / v0.2.0); CI publishes via Trusted Publishing.
5. Consumers: pip install -e ../flux_hopf_lib while iterating; pin ==0.1.0 (PyPI) or @v0.1.0 (git) for HF / papers.

Tests

pip install -e ".[dev]"
pytest

License

MIT — see LICENSE.

Ecosystem links

Repo	URL
flux_hopf_lib	https://github.com/kinaar8340/flux_hopf_lib
toe	https://github.com/kinaar8340/toe
mystery	https://github.com/kinaar8340/mystery
hfb	https://github.com/kinaar8340/hfb
vqc_proto	https://github.com/kinaar8340/vqc_proto
vqc_sims_public	https://github.com/kinaar8340/vqc_sims_public
kingdom_come	https://github.com/kinaar8340/kingdom_come