Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

pyboltzmann

An SDK for the Boltzmann Protocol: portable, verifiable, model-agnostic knowledge.

The brain conserves, validates, and retrieves knowledge. An external LLM processes, contextualizes, and uses it.

Reference: Boltzmann Brain: A Versioned, Distributable, and Model-Agnostic Knowledge Architecture (Gaussia, 2026).

What this is

A client for a Boltzmann brain. You open a directory, call methods, and they work against an OCI artifact. Brain implements the complete protocol, including hierarchical catalog navigation.

brain = Brain.open("./my-brain", actor=curator)
brain.ingest(pdf, request, my_llm)          # register → delegate → validate → commit
brain.search(Query(text="Fourier"))         # filter, resolve, verify
brain.drop(DropRequest(...))                # rebuild the Merkle DAG, cascade, record
await brain.push(client, "ghcr.io/org/brain", "v1")

The line it draws: the SDK does whatever the protocol defines mechanically; the implementer supplies whatever the paper assigns elsewhere. Identity, the wire formats, the four operation paths and a conformance suite are here; the model, the ranking, the index engines and any CLI or MCP server are yours. No language model is embedded — interpretation enters through CandidateProposer and nowhere else.

Installation

pip install pyboltzmann          # the distribution
pip install 'pyboltzmann[oci]'   # plus the network registry transport
import boltzmann                 # the import package

The two names differ because boltzmann on PyPI belongs to an unrelated package — the same split as pygaussia providing gaussia.

Python >= 3.11. The core needs only pydantic and rfc8785; [oci] adds the network registry transport.

Usage

The whole lifecycle of Section 11, against a real OCI layout:

from boltzmann import Actor, Brain, MemoryType, Producer, Query
from boltzmann.blocks import ActorKind, ProducerKind
from boltzmann.ingest import Candidate, CandidateSet, RegistrationRequest

curator = Actor(id="curator", kind=ActorKind.HUMAN)
brain = Brain.open("./my-brain", actor=curator)

# You supply the model. The SDK embeds none: what knowledge a source yields is its
# judgment, and what gets stored is the protocol's.
def my_llm(task, source):
    # task.output_schema names the schema; brain.candidates_schema(task) *is* it, with the
    # payload resolved per memory type. Hand it to the model as structured output.
    return CandidateSet(
        producer=Producer(kind=ProducerKind.MODEL, id="claude-opus-5", version="2026-07"),
        candidates=[
            Candidate(
                memory_type=MemoryType.SEMANTIC,
                evidence=[task.source],
                locator="p.147",
                payload={
                    "kind": "formula",
                    "label": "Fourier series",
                    "statement": "decomposes a periodic function into sines",
                    "subject": "signals",
                },
            )
        ],
    )

request = RegistrationRequest(media_type="application/pdf", actor=curator, license="CC-BY-4.0")
pdf = b"%PDF-1.7 lecture 07: Fourier analysis"

# Register, delegate, validate, commit. Registering the same source twice is a no-op.
commit = brain.ingest(pdf, request, my_llm)

# Data with its provenance, never prose, every match verified against the snapshot.
bundle = brain.search(Query(text="periodic function"))
assert bundle.all_verified
assert bundle.matches[0].sources[0].locator == "p.147"

# Membership is provable in O(log n), without holding the rest of the module.
block_id = commit.committed[0]
assert brain.prove(block_id, MemoryType.SEMANTIC).verify(brain.root_of(MemoryType.SEMANTIC))
assert brain.verify()

Documentation

The docs/ directory is the source of truth, and it is published as the Boltzmann SDK section of the Gaussia docs.

Quickstart Ingest, query, prove, publish, remove — in one file
Architecture Blocks, compositions, modules, snapshots
Memory types The five typed blocks and the rules each obeys
Identity JCS, the three levels of hashes, the values a payload refuses
Merkle DAGs RFC 9162 over sorted leaves, and inclusion proofs
Catalog Hierarchical classes and virtual paths over canonical sources
Interfaces The protocol surface, and the things you plug in
Ingestion Preserve the source, delegate the interpretation, validate
Query Evidence Bundles, filters, and supplying a planner
Retention Drop, supersede, demote, prune, redact
Distribution Pack, push, pull, and selective installs
Conformance Golden vectors, and the suites you inherit

Development

uv sync
uv run pre-commit install && uv run pre-commit install --hook-type commit-msg

uv run ruff check . && uv run ruff format .
uv run mypy src
uv run pytest

Commits follow Conventional Commits — use uv run cz commit for the interactive prompt. Releases are cut by python-semantic-release from the commit history.

License

MIT — see LICENSE.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyboltzmann-0.8.0b9.tar.gz (294.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyboltzmann-0.8.0b9-py3-none-any.whl (357.0 kB view details)

Uploaded Python 3

File details

Details for the file pyboltzmann-0.8.0b9.tar.gz.

File metadata

  • Download URL: pyboltzmann-0.8.0b9.tar.gz
  • Upload date:
  • Size: 294.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pyboltzmann-0.8.0b9.tar.gz
Algorithm Hash digest
SHA256 a322853ab96b6190fa47c617b6fb2a7ee51c51e82f57b67cf39583ca6157b082
MD5 dd0d1196a2c93dc54e24f67fb482bf72
BLAKE2b-256 5d92b96f90c6bcbaa8a0087a95a8f2ba44d337ae75ad43a8a2b7c46dbc041593

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyboltzmann-0.8.0b9.tar.gz:

Publisher: release.yml on gaussia-labs/pyboltzmann

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyboltzmann-0.8.0b9-py3-none-any.whl.

File metadata

  • Download URL: pyboltzmann-0.8.0b9-py3-none-any.whl
  • Upload date:
  • Size: 357.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pyboltzmann-0.8.0b9-py3-none-any.whl
Algorithm Hash digest
SHA256 06551787ac483b66b675b9ed6bb37e6d3a020b5a9763b4a69bba3938708c8c15
MD5 872e7e4b14811879bf40b77609b5ecad
BLAKE2b-256 67d285e94a9f5ee299fe87a27bd98d2169cdb057ee0f0f2b82b84b52f2f2013e

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyboltzmann-0.8.0b9-py3-none-any.whl:

Publisher: release.yml on gaussia-labs/pyboltzmann

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.9.0

2 files

0.8.0

2 files

This release

0.8.0b9 This release

2 files

0.7.0

2 files

0.6.0

2 files

0.5.0

2 files

0.4.1

2 files

0.4.0

2 files

0.3.0

2 files

0.3.0b1

2 files

0.2.0

2 files

0.1.1

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page