Docs / Quick Start

Getting Started

Quick Start

Review the Python SDK shape and run a first delta-state operation. Treat workload performance, deployment support, and protocol behavior as separate evaluation questions.

Install

$ pip install atomik-core

The four operations

from atomik_core import AtomikContext

# Create a single delta-state context
ctx = AtomikContext()

# LOAD — set the initial reference state
ctx.load(0xDEADBEEF)

# ACCUM — XOR a delta into the accumulator
ctx.accum(0x000000FF)

# READ — reconstruct current state (reference XOR accumulator)
assert ctx.read() == 0xDEADBE10

# SWAP — atomic snapshot + reset accumulator
snapshot = ctx.swap()
assert snapshot == 0xDEADBE10  # previous state
assert ctx.read() == 0xDEADBE10    # accumulator reset, state preserved

Key insight

In the accumulator model, current state is reconstructed from a reference and accumulated delta: current_state = initial_state ⊕ accumulator. XOR deltas are commutative, associative, and self-inverse in the algebraic model. Production ordering, replay, duplicate handling, and packaging claims still require workload-specific validation.

Historical articles and technical notes may include exploratory examples, synthesis figures, or modeled comparisons. Treat performance, power, savings, customer, production, and deployment claims as public-safe only when they are linked to measured artifacts or explicit evidence labels. Start with the current docs or evidence-label definitions.
CompatibilityAPI Reference