vibe-sketcherDocumentation

vibesketcher.document.periodic_capabilities

What the vibe-qc engine can do for periodic tasks, pinned to one engine release (#208).

Recipe planners in vibesketcher.document.periodic_recipes consult this table before they write anything. A task the pinned engine does not offer on a route is refused with the engine’s own reason and the tracker item that owns the missing capability; it is never mapped to a nearby route. The table is read from the engine’s front door (vibeqc.run_periodic_job and the library entry points it names), not inferred from method names: a model name that is not listed here (ORB, MatterSim, UFF4MOF, DFTB+ and so on) is not an admission, and molecular MACE admissions do not carry over to periodic cells or the other way round.

Statuses:

  • admitted: the pinned engine runs the task on that route and the sketcher writes the input;

  • library: the engine has a library function for the task but the sketcher writes no input for it (the reason says what to call);

  • refused: the engine refuses the task on that route.

Update ENGINE and the rows together when the pinned engine changes.

Module Attributes

ENGINE

The engine release the table was read from.

Functions

admitted(task, model, dim)

The admitting row, or None when the engine (or the sketcher) does not run it.

lookup(task, model, dim)

The rows for task on model that cover a dim-periodic cell.

refusal(task, model, dim)

An engine-refusal report: what was asked, what the engine says and who owns it.

table()

The pinned engine and every row, for the SDK, CLI, REST and MCP.

Classes

Capability(*, task, model, route, dims, ...)

One task on one model and route of the pinned engine.

vibesketcher.document.periodic_capabilities.ENGINE: dict[str, str] = {'front_door': 'vibeqc.run_periodic_job', 'program': 'vibe-qc', 'source': 'vibe-qc main at c9ba9cd6 (2026-11-10)', 'version': '0.18.12'}

The engine release the table was read from. source names the commit.

class vibesketcher.document.periodic_capabilities.Capability(*, task, model, route, dims, status, entry_point, reason, issue=None)[source]

Bases: BaseModel

One task on one model and route of the pinned engine.

Parameters:
  • task (Literal['energy', 'forces', 'relax_positions', 'relax_positions_frozen', 'stress', 'relax_cell', 'hessian', 'phonons', 'ir_intensities', 'free_energy'])

  • model (str)

  • route (str)

  • dims (tuple[int, ...])

  • status (Literal['admitted', 'library', 'refused'])

  • entry_point (str)

  • reason (str)

  • issue (str | None)

model_config = {'extra': 'forbid', 'frozen': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

task: Task
model: str
route: str
dims: tuple[int, ...]
status: Status
entry_point: str
reason: str
issue: str | None
vibesketcher.document.periodic_capabilities.table()[source]

The pinned engine and every row, for the SDK, CLI, REST and MCP.

Return type:

dict[str, Any]

vibesketcher.document.periodic_capabilities.lookup(task, model, dim)[source]

The rows for task on model that cover a dim-periodic cell.

Parameters:
Return type:

list[Capability]

vibesketcher.document.periodic_capabilities.admitted(task, model, dim)[source]

The admitting row, or None when the engine (or the sketcher) does not run it.

Parameters:
Return type:

Capability | None

vibesketcher.document.periodic_capabilities.refusal(task, model, dim)[source]

An engine-refusal report: what was asked, what the engine says and who owns it.

Parameters:
Return type:

dict[str, Any]