vibesketch.server.documents

Document routes: create, read, edit, import, report, render, export, save.

Every write names the revision it read: If-Match on PUT of a whole document, a revision field on the smaller edits. A stale write answers 409 with the current revision, and the client re-reads (roadmap, section 3.2). Each accepted edit is recorded in the document’s provenance; a run of edits of the same kind from the same client is folded into one entry, so a drawing session does not leave hundreds.

Functions

make_router(store)

Classes

AbbreviationsRequest(*[, actor, client, ...])

Contract or expand abbreviations: of one species or all, of some labels or all.

AmountsRequest(*[, actor, client])

The amounts entered for a reaction's participants; an empty list clears them.

ApparatusRequest(*[, actor, client, at, ...])

A laboratory apparatus pictogram to draw, and where.

AttachRequest(*[, actor, client, anchor, node])

Move a labelled structure onto a nanostructure picture's anchor (#138).

BaselineRecipeRequest(*[, actor, client, ...])

The publication baseline recipe for species, reactions or the whole scheme.

CampaignEnergyRequest(*, stage[, reactions, ...])

CanvasRequest(*[, actor, client])

CapRequest(*[, actor, client])

Cap a labelled structure's attachment atoms to make a species (#139).

ClearHighlightsRequest(*[, actor, client, ...])

CompileRequest(*[, actor, client, id, host, ...])

Where and how to compile a recipe into a vibe-queue campaign.

CompileResponse(*, id, revision, document, ...)

CreateRequest(*[, actor, client, document, ...])

DocumentResponse(*, id, revision, document, ...)

DocumentSummary(*, id, revision, file, ...)

Editor(*[, actor, client])

Who is editing; recorded in the provenance.

Embed3dRequest(*, smiles[, count])

EmbedRequest(*[, actor, client, species, ...])

Which species to give 3D structures, and how many conformers each.

EnergyRecipeRequest(*[, actor, client])

EnergyResultRequest(*, runs[, figure])

EnumerationRequest(*[, actor, client, core])

ExternalChainRequest(*, data, sha256, ...[, ...])

GeometryReturnRequest(*[, actor, client])

HalfReactionRequest(*[, actor, client, ...])

An electrode half-reaction to draw beside the drawing (#141).

HighlightPointsRequest(*, ket)

HighlightRequest(*[, actor, client, colour])

Mark atoms of a species, numbered from 1 as in the species report.

ImportRequest(*[, actor, client, mode, encoding])

InputsRequest(*, program, spec[, species, ...])

One writer and one specification for several species of the document.

MappingRequest(*[, pins])

Pinned atom pairs for a reaction's mapping, reactant:atom=product:atom.

NanostructureRequest(*[, actor, client, ...])

A nanostructure to generate and add as a species (#137).

NanostructureResponse(*, id, revision, ...)

NebRequest(*[, program, pins, format])

A reaction-path input: the program, the band and the level of theory, and any pins.

NmrLabelsRequest(*[, actor, client, nuclei])

Place a run's NMR shifts as labels beside its species' structure.

PictureRequest(*[, actor, client, style, ...])

A nanostructure picture to put on the canvas (#138).

PropertyTextRequest(*[, actor, client, fields])

Which lines the property text under a structure shows.

QvfOverwriteRequest(*, data)

The existing destination's bytes, never a filesystem path.

QvfOverwriteResponse(*, allowed, reason)

ReactionLibraryRequest(*[, actor, client, kind])

RecipeRequest(*[, actor, client])

A recipe to save on the document, replacing one with the same id.

RecipeResponse(*, id, revision, document, ...)

Relax3dRequest(*, smiles, conformer[, ...])

RelaxRequest(*[, actor, client, species, ...])

Which species to relax, on which force field, and what to hold.

RelaxResponse(*, id, revision, document, ...)

RenderStagesRequest(*, species, directory[, ...])

Which species to render, where, and how big.

ResultFileRequest(*[, actor, client])

ResultImportRequest(*[, actor, client, replace])

ResultReportRequest(*[, group, runs, ...])

ResultViewRequest(*, view[, artifact, mode, ...])

RetryRequest(*, node)

RevalidateRequest(*[, actor, client])

ReviewRequest(*[, actor, client])

RevisionRequest(*[, actor, client])

An edit that needs nothing but the revision it is based on.

SelectionHighlightRequest(*[, actor, ...])

Mark the atoms the canvas has selected, at their points in its own KET.

SpeciesRequest(*[, actor, client, label, ...])

Change what the drawing cannot say about a species.

StereoLabelsRequest(*[, actor, client, clear])

Write the drawn structures' CIP descriptors as labels, or remove them.

SubmitRequest(*[, actor, client, species, ...])

One program and specification for species of the document, sent to vibe-queue.

SubmitResponse(*, id, revision, document, ...)

SurfaceRequest(*[, actor, client, at, ...])

TemplateLibraryRequest(*[, actor, client, ...])

TidyRequest(*[, actor, client, width])

Lay the scheme out; rows longer than width bond lengths turn down.

TlcRequest(*[, actor, client])

The lanes of a TLC plate to draw beside the drawing.

ViewRequest(*, species)

vibesketch.server.documents.make_router(store)[source]
Parameters:

store (Store)

Return type:

APIRouter