vibe-sketcherDocumentation

vibesketcher.server.periodic_recipes

REST routes for periodic scan, phonon and free-energy recipes and EOS analysis (#208).

Planning reads a document and changes nothing: the answer is the plan, the generated inputs (one per point plus run_all.py) and the document revision it was planned against, or the refusal. Analysis is stateless.

Functions

router(store)

Classes

EosAnalyseRequest(*[, table, plan, results, ...])

A vibe-eos-table/1 table, or a volume-scan plan with its results.

FrequencyRequest(*, frequencies_cm1[, ...])

Explicit frequencies for an independent harmonic free-energy check.

RecipePlanRequest(*, recipe)

class vibesketcher.server.periodic_recipes.RecipePlanRequest(*, recipe)[source]

Bases: BaseModel

Parameters:

recipe (dict[str, Any])

model_config = {'extra': 'forbid'}

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

recipe: dict[str, Any]

volume_scan, coordinate_scan, phonons or free_energy recipe.

class vibesketcher.server.periodic_recipes.EosAnalyseRequest(*, table=None, plan=None, results=None, qvfs=<factory>, drop_unconverged=False, svg=False, title=None)[source]

Bases: BaseModel

A vibe-eos-table/1 table, or a volume-scan plan with its results.

Parameters:
model_config = {'extra': 'forbid'}

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

table: dict[str, Any] | None
plan: dict[str, Any] | None
results: dict[str, Any] | None

scan-results.json written by the plan’s run_all.py.

qvfs: dict[str, str]

Point label to a base64 result QVF.

drop_unconverged: bool
svg: bool

Include the E(V) plot as SVG text.

title: str | None
class vibesketcher.server.periodic_recipes.FrequencyRequest(*, frequencies_cm1, weights=None, temperatures_k=<factory>)[source]

Bases: BaseModel

Explicit frequencies for an independent harmonic free-energy check.

Parameters:
model_config = {'extra': 'forbid'}

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

frequencies_cm1: list[float]
weights: list[float] | None
temperatures_k: list[float]
vibesketcher.server.periodic_recipes.router(store)[source]
Parameters:

store (Store)

Return type:

APIRouter