vibesketch.document.template_library¶

Offline compounds, open-attachment fragments and the full named-reaction index.

Functions

`get_template`(identifier)
`insert_template`(document, identifier, *[, ...])	Append a separate editable block, preserving the document and existing chemistry.
`list_templates`([query, category, kind])	Search names, aliases, formulae and categories; optional exact category/kind filters.
`template_fragment`(identifier, *[, scaffold])	Return editable KET; incomplete reactions require explicit scaffold selection.

Classes

TemplateEntry(*, id, name, aliases, category)

class vibesketch.document.template_library.TemplateEntry(*, id, name, aliases, category, tags=(), kind, sources, note, smiles=None, formula=None, attachment_points=0, scope='chemical', parameters=None)[source]¶

Bases: BaseModel

Parameters:

id (str)
name (str)
aliases (tuple[str, ...])
category (str)
tags (tuple[str, ...])
kind (Literal['compound', 'fragment', 'polymer', 'nanostructure', 'example', 'scaffold', 'reference'])
sources (tuple[ReactionSource, ...])
note (str)
smiles (str | None)
formula (str | None)
attachment_points (int)
scope (str)
parameters (Annotated[Nanotube | Graphene | Nanoribbon | Fullerene, FieldInfo(annotation=NoneType, required=True, discriminator='kind')] | None)

model_config = {'frozen': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

id: str¶

name: str¶

aliases: tuple[str, ...]¶

category: str¶

tags: tuple[str, ...]¶

kind: TemplateKind¶

sources: tuple[ReactionSource, ...]¶

note: str¶

smiles: str | None¶

formula: str | None¶

attachment_points: int¶

scope: str¶

parameters: NanostructureParameters | None¶

vibesketch.document.template_library.list_templates(query='', *, category='', kind='')[source]¶

Search names, aliases, formulae and categories; optional exact category/kind filters.

Parameters:

query (str)
category (str)
kind (str)

Return type:

list[TemplateEntry]

vibesketch.document.template_library.get_template(identifier)[source]¶

Parameters:: identifier (str)
Return type:: TemplateEntry

vibesketch.document.template_library.template_fragment(identifier, *, scaffold=False)[source]¶

Return editable KET; incomplete reactions require explicit scaffold selection.

Parameters:

identifier (str)
scaffold (bool)

Return type:

dict[str, Any]

vibesketch.document.template_library.insert_template(document, identifier, *, scaffold=False)[source]¶

Append a separate editable block, preserving the document and existing chemistry.

Parameters:

document (Document)
identifier (str)
scaffold (bool)

Return type:

Derivation