vibe-sketcherDocumentation

Source code for vibesketcher.server.wyckoff

"""Wyckoff positions over REST (#229): list a setting's positions, analyse sites."""

from __future__ import annotations

from typing import Any

from fastapi import APIRouter, HTTPException
from pydantic import BaseModel, ConfigDict, Field


[docs] class WyckoffSitesRequest(BaseModel): model_config = ConfigDict(extra="forbid") group: str | int #: ``{"position": "12c", "parameters": {"z": 0.35}}`` or ``{"fractional": [x, y, z]}``. sites: list[dict[str, Any]] = Field(default_factory=list, max_length=500) tolerance: float = Field(default=1e-4, gt=0, le=0.05)
[docs] def router() -> APIRouter: routes = APIRouter(prefix="/api/periodic/space-groups", tags=["periodic"]) @routes.get("/wyckoff") def wyckoff_positions(group: str) -> dict[str, Any]: """The Wyckoff positions of a setting: letter, multiplicity, site symmetry, triplet.""" from vibesketcher.document import wyckoff try: return wyckoff.describe(group) except ValueError as error: raise HTTPException(422, {"errors": [str(error)]}) from None @routes.post("/sites") def wyckoff_sites(request: WyckoffSitesRequest) -> dict[str, Any]: """Each site's Wyckoff position, free parameters and orbit in the conventional cell.""" from vibesketcher.document import wyckoff try: return wyckoff.analyse_sites(request.group, request.sites, request.tolerance) except (ValueError, TypeError) as error: raise HTTPException(422, {"errors": [str(error)]}) from None return routes