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@example.org", 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.

Metadata

Release files for pyboltzmann 0.10.1b1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyboltzmann 0.10.1b1
File Size Uploaded Provenance
pyboltzmann-0.10.1b1.tar.gz 341.6 kB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for pyboltzmann 0.10.1b1
File Interpreter ABI Platform
pyboltzmann-0.10.1b1-py3-none-any.whl Python 3 none any Details

Total release size: 751.7 kB

Release files / pyboltzmann-0.10.1b1.tar.gz

Download URL pyboltzmann-0.10.1b1.tar.gz
Size 341.6 kB
Tags Source
SHA-256 checksum
How to use checksums
2e3125356490c52920423143718679424d5325d6d7c1469ef34cdab337a90c29
BLAKE2b-256 checksum
How to use checksums
f2f3f79a030cfa83a622e2c34a9c4ac51273c67966475d43e4ca669a510d0d6d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 6, 2026.

Transparency log

Release files / pyboltzmann-0.10.1b1-py3-none-any.whl

Download URL pyboltzmann-0.10.1b1-py3-none-any.whl
Size 410.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8e4ff720c3025535c915229caf2f78411e5680d314161fd818a61ecc420fbdde
BLAKE2b-256 checksum
How to use checksums
5f5b22d0530bdaaa6f35486cb3a721f332f2edb563e79207e7ff795aba1fc30e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 6, 2026.

Transparency log

Security for pyboltzmann 0.10.1b1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for pyboltzmann-0.10.1b1.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 6, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release
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