fockit 0.0.2__tar.gz

fockit-0.0.2/.gitignore

@@ -0,0 +1,48 @@
+# Byte-compiled / cache
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Virtual environments
+venv/
+.env/
+.venv/
+env/
+ENV/
+
+.env
+.env.*
+
+# Pytest
+.pytest_cache/
+
+# Coverage reports
+.coverage
+.coverage.*
+htmlcov/
+
+# Distribution / packaging
+build/
+dist/
+*.egg-info/
+.eggs/
+*.egg
+
+# mypy
+.mypy_cache/
+
+# Ruff / flake8 / pylint caches
+.ruff_cache/
+
+*.log
+*.tmp
+*.swp
+
+# macOS
+.DS_Store
+
+# project specific
+src/fockit/_version.py

fockit-0.0.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Henry L. Nourse
+
+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.

fockit-0.0.2/PKG-INFO

@@ -0,0 +1,83 @@
+Metadata-Version: 2.4
+Name: fockit
+Version: 0.0.2
+Summary: Build many-body models, write your own operator algebras, and test algorithms on them
+Project-URL: Homepage, https://github.com/thenoursehorse/fockit
+Author: Henry L. Nourse
+License-Expression: MIT
+License-File: LICENSE
+Keywords: algebra,bosons,fermions,many-body,operator,quantum,spins
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.14
+Provides-Extra: solve
+Requires-Dist: numpy>=1.26; extra == 'solve'
+Requires-Dist: scipy>=1.11.4; extra == 'solve'
+Provides-Extra: sympy
+Requires-Dist: sympy>=1.12; extra == 'sympy'
+Description-Content-Type: text/markdown
+
+# fockit - Quantum many-body operators and solvers
+
+Copyright (C) 2026 H. L. Nourse
+
+## What is fockit?
+
+Build many-body models, write your own operator algebras, and test algorithms
+on them. Quick and simple.
+
+Comes with fermions, bosons and Pauli operators, and you can add your own.
+Simple exact solvers check your ideas on small systems.
+
+## Where to start?
+
+The tests are examples:
+
+- `tests/test_integration.py` for the operator algebra.
+- `tests/solve/` for matrices and solvers.
+- `tests/solve/test_symmetries.py` for symmetry sectors (momentum, reflection,
+  spin flip, spin inversion, particle-hole, point groups).
+
+## Dependencies
+
+- [python](https://www.python.org/) version `>= 3.12`
+- [numpy](https://numpy.org/) and [scipy](https://scipy.org/) for the solvers
+- [sympy](https://www.sympy.org/) for symbolic coefficients (optional)
+
+## Installation
+
+Clone source
+
+```shell
+git clone https://github.com/thenoursehorse/fockit
+cd fockit
+```
+
+Install with [uv](https://docs.astral.sh/uv)
+
+```shell
+uv sync --extra solve
+```
+
+Add `--extra sympy` for symbolic coefficients.
+
+## Tests
+
+```shell
+uv sync --group test --extra sympy --extra solve
+uv run pytest
+```
+
+## Development
+
+```shell
+uv sync --group all --extra sympy --extra solve
+```
+
+## AI use
+
+This code was written with AI coding assistants (Claude Code and Codex). All of
+it is reviewed and tested.

fockit-0.0.2/README.md

@@ -0,0 +1,61 @@
+# fockit - Quantum many-body operators and solvers
+
+Copyright (C) 2026 H. L. Nourse
+
+## What is fockit?
+
+Build many-body models, write your own operator algebras, and test algorithms
+on them. Quick and simple.
+
+Comes with fermions, bosons and Pauli operators, and you can add your own.
+Simple exact solvers check your ideas on small systems.
+
+## Where to start?
+
+The tests are examples:
+
+- `tests/test_integration.py` for the operator algebra.
+- `tests/solve/` for matrices and solvers.
+- `tests/solve/test_symmetries.py` for symmetry sectors (momentum, reflection,
+  spin flip, spin inversion, particle-hole, point groups).
+
+## Dependencies
+
+- [python](https://www.python.org/) version `>= 3.12`
+- [numpy](https://numpy.org/) and [scipy](https://scipy.org/) for the solvers
+- [sympy](https://www.sympy.org/) for symbolic coefficients (optional)
+
+## Installation
+
+Clone source
+
+```shell
+git clone https://github.com/thenoursehorse/fockit
+cd fockit
+```
+
+Install with [uv](https://docs.astral.sh/uv)
+
+```shell
+uv sync --extra solve
+```
+
+Add `--extra sympy` for symbolic coefficients.
+
+## Tests
+
+```shell
+uv sync --group test --extra sympy --extra solve
+uv run pytest
+```
+
+## Development
+
+```shell
+uv sync --group all --extra sympy --extra solve
+```
+
+## AI use
+
+This code was written with AI coding assistants (Claude Code and Codex). All of
+it is reviewed and tested.

fockit-0.0.2/pyproject.toml

@@ -0,0 +1,138 @@
+[project]
+name = "fockit"
+dynamic = ["version"]
+description = "Build many-body models, write your own operator algebras, and test algorithms on them"
+readme = "README.md"
+requires-python = ">=3.14"
+license = "MIT"
+license-files = ["LICENSE"]
+keywords = ["quantum", "many-body", "operator", "algebra", "fermions", "bosons", "spins"]
+authors = [
+  {name = "Henry L. Nourse"},
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.14",
+    "Operating System :: OS Independent",
+    "Intended Audience :: Science/Research",
+    "Topic :: Scientific/Engineering",
+]
+
+[project.urls]
+Homepage = "https://github.com/thenoursehorse/fockit"
+
+[project.optional-dependencies]
+sympy = [
+  "sympy>=1.12",
+]
+solve = [
+  "numpy>=1.26",
+  "scipy>=1.11.4",
+]
+
+[build-system]
+# hatchling 1.32 writes metadata 2.5, which twine doesn't accept yet
+requires = ["hatchling<1.32", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[tool.hatch]
+version.source = "vcs"
+build.hooks.vcs.version-file = "src/fockit/_version.py"
+build.targets.sdist.include = ["src", "tests", "README.md", "LICENSE", "pyproject.toml"]
+metadata.allow-direct-references = true
+
+[dependency-groups]
+test = [
+  "pytest>=8.3",
+  "pytest-subtests>=0.14",
+  "pytest-cov>=6.0",
+]
+dev = [
+  { include-group = "test" },
+  "pre-commit>=4.0",
+  "ruff>=0.8.0",
+  "mypy>=1.13",
+]
+all = [
+  {include-group = "test"},
+  {include-group = "dev"},
+]
+
+[tool.pytest]
+minversion = "8.3"
+addopts = ["-ra", "--showlocals"]
+strict = true
+filterwarnings = ["error"]
+log_level = "INFO"
+testpaths = [
+  "tests",
+]
+
+[tool.ruff]
+src = ["src"]
+target-version = "py314"
+line-length = 88
+extend-exclude = ["src/fockit/_version.py"]
+
+[tool.ruff.format]
+docstring-code-format = true
+quote-style = "double"
+indent-style = "space"
+
+[tool.ruff.lint]
+extend-select = [
+  "B",           # flake8-bugbear
+  "I",           # isort
+  "E",           # pycodestyle errors
+  "F",           # pyflakes (bugs)
+  "ARG",         # flake8-unused-arguments
+  "C4",          # flake8-comprehensions
+  "EM",          # flake8-errmsg
+  "ICN",         # flake8-import-conventions
+  "PGH",         # pygrep-hooks
+  "PIE",         # flake8-pie
+  "PL",          # pylint
+  "PT",          # flake8-pytest-style
+  "PTH",         # flake8-use-pathlib
+  "RET",         # flake8-return
+  "RUF",         # Ruff-specific
+  "SIM",         # flake8-simplify
+  "TID251",      # flake8-tidy-imports.banned-api
+  "T20",         # flake8-print
+  "UP",          # pyupgrade
+  "YTT",         # flake8-2020
+  "D",           # pydocstyle
+  "D204",        # one-blank-line-after-class
+  "D301",        # escape-sequence-in-docstring
+  "D413",        # blank-line-after-last-section
+  "UP",          # pyupgrade (modern Python)
+]
+ignore = [
+  "PLR",    # Design related pylint codes
+  "PLC0415", # allow lazy imports (not at top of file)
+  "RUF012", # Would require a lot of ClassVar's
+  "D417",  # remove documentation requirement for all functions
+]
+allowed-confusables = ["σ"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["D"]
+
+[tool.ruff.lint.pycodestyle]
+max-doc-length = 75
+max-line-length = 88
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"
+
+[tool.mypy]
+files = "src"
+python_version = "3.14"
+strict = true
+show_error_codes = true
+enable_error_code = ["ignore-without-code", "redundant-expr", "truthy-bool"]
+warn_unreachable = true
+
+[[tool.mypy.overrides]]
+module = ["scipy.*", "sympy.*", "triqs.*"]
+ignore_missing_imports = true

fockit-0.0.2/src/fockit/__init__.py

@@ -0,0 +1,53 @@
+"""Symbolic operator algebra for fermions, bosons, and beyond."""
+
+from fockit.constructors import (
+    b,
+    bdag,
+    c,
+    cdag,
+    n,
+    nb,
+    sigma_x,
+    sigma_y,
+    sigma_z,
+    sm,
+    sp,
+)
+from fockit.display import to_latex, to_text
+from fockit.inspection import degree, modes, num_terms
+from fockit.normal_order import is_normal_ordered, normal_order
+from fockit.operators import (
+    identity,
+    zero,
+)
+from fockit.simplify import drop_zeros, simplify_coeffs
+from fockit.transforms import anticommutator, commutator, hc, substitute_modes
+
+__all__ = [
+    "anticommutator",
+    "b",
+    "bdag",
+    "c",
+    "cdag",
+    "commutator",
+    "degree",
+    "drop_zeros",
+    "hc",
+    "identity",
+    "is_normal_ordered",
+    "modes",
+    "n",
+    "nb",
+    "normal_order",
+    "num_terms",
+    "sigma_x",
+    "sigma_y",
+    "sigma_z",
+    "simplify_coeffs",
+    "sm",
+    "sp",
+    "substitute_modes",
+    "to_latex",
+    "to_text",
+    "zero",
+]

fockit-0.0.2/src/fockit/_types.py

@@ -0,0 +1,48 @@
+"""Shared typing helpers."""
+
+from __future__ import annotations
+
+from collections.abc import Hashable
+from typing import Protocol, SupportsComplex, SupportsFloat, SupportsIndex, cast
+
+type Mode = Hashable
+
+
+class SymbolicCoefficient(Protocol):
+    """Protocol for symbolic coefficient objects."""
+
+    def __hash__(self) -> int: ...
+
+    def __add__(self, other: object, /) -> object: ...
+
+    def __radd__(self, other: object, /) -> object: ...
+
+    def __sub__(self, other: object, /) -> object: ...
+
+    def __rsub__(self, other: object, /) -> object: ...
+
+    def __mul__(self, other: object, /) -> object: ...
+
+    def __rmul__(self, other: object, /) -> object: ...
+
+    def __neg__(self) -> object: ...
+
+    def __abs__(self) -> object: ...
+
+    def __eq__(self, other: object, /) -> bool: ...
+
+    def conjugate(self) -> object: ...
+
+
+type Coefficient = int | float | complex | SymbolicCoefficient
+type ComplexConvertible = complex | SupportsComplex | SupportsFloat | SupportsIndex
+
+
+def as_coefficient(value: object) -> Coefficient:
+    """Cast a coefficient result back to ``Coefficient``."""
+    return cast(Coefficient, value)
+
+
+def as_complex(value: Coefficient) -> complex:
+    """Convert a coefficient to ``complex``."""
+    return complex(cast(ComplexConvertible, value))

fockit-0.0.2/src/fockit/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '0.0.2'
+__version_tuple__ = version_tuple = (0, 0, 2)
+
+__commit_id__ = commit_id = None