vibesketcher.server.symmetry_ops¶
REST routes for adopting symmetry, enantiomorphs and subgroup descent (#199).
Previews read the current document and name its revision; every mutation
names the revision it read (409 when stale) and is recorded as an edit.
.../symmetry/undo reverts the last adoption of a structure, or removes an
enantiomorph or subgroup structure that is unchanged since it was derived.
.../symmetry/drop-displacements drops measured displacement tensors with a
recorded reason, which edits that cannot transform them require.
Functions
|
Classes
|
|
|
|
|
|
|
|
|
|
|
|
|
- class vibesketcher.server.symmetry_ops.AdoptOptions(*, symprec=0.001, idealize=False, diagnostic_symprec=0.1)[source]¶
Bases:
BaseModel- Parameters:
- model_config = {'extra': 'forbid'}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class vibesketcher.server.symmetry_ops.AdoptRequest(*, actor='agent', client='rest', revision, symprec=0.001, idealize=False, diagnostic_symprec=0.1, source_sha256)[source]¶
Bases:
RevisionRequest- Parameters:
- model_config = {'extra': 'forbid'}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class vibesketcher.server.symmetry_ops.EnantiomorphOptions(*, symprec=0.001, diagnostic_symprec=0.1)[source]¶
Bases:
BaseModel- Parameters:
- model_config = {'extra': 'forbid'}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class vibesketcher.server.symmetry_ops.EnantiomorphRequest(*, actor='agent', client='rest', revision, identifier, symprec=0.001, diagnostic_symprec=0.1)[source]¶
Bases:
RevisionRequest- Parameters:
- model_config = {'extra': 'forbid'}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class vibesketcher.server.symmetry_ops.DescendOptions(*, transformation, subgroup, symprec=0.001)[source]¶
Bases:
BaseModel- Parameters:
- model_config = {'extra': 'forbid'}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class vibesketcher.server.symmetry_ops.DescendRequest(*, actor='agent', client='rest', revision, identifier, transformation, subgroup, symprec=0.001)[source]¶
Bases:
RevisionRequest- Parameters:
actor (Literal['human', 'agent', 'system'])
client (Annotated[str, _PydanticGeneralMetadata(pattern='^[a-z0-9][a-z0-9_.:+-]{0,63}$')])
revision (int)
identifier (Annotated[str, _PydanticGeneralMetadata(pattern='^[A-Za-z][A-Za-z0-9_-]{0,63}$')])
transformation (Annotated[str, MinLen(min_length=5), MaxLen(max_length=200)])
subgroup (Annotated[str, MinLen(min_length=1), MaxLen(max_length=40)])
- model_config = {'extra': 'forbid'}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class vibesketcher.server.symmetry_ops.DropDisplacementsRequest(*, actor='agent', client='rest', revision, reason)[source]¶
Bases:
RevisionRequest- Parameters:
- model_config = {'extra': 'forbid'}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].