vibesketcher.document.wyckoff¶
Wyckoff positions of the space-group settings (#229).
A Wyckoff position is a class of points whose site-symmetry groups are
conjugate in the space group; its multiplicity is the number of points of one
orbit in the conventional cell, the order of G over that of the site group
(International Tables for
Crystallography, Vol. A, sections 1.4.4 and 2.1.3.11). The letters (a for
the most special position, the general position last, and A for the 27th
position of P m m m, which the Tables write as alpha), the oriented site-symmetry
symbols and the first coordinate triplet of each position come from
data/wyckoff_positions.json, generated from spglib’s database by
scripts/generate_wyckoff_table.py.
Nothing here trusts the table. check_setting() recomputes the
site-symmetry orbits from the setting’s operations (spacegroups): every
multiplicity must equal the orbit size of a generic point on its triplet, and
every point of a 1/24 grid of the cell (which holds every fixed special
position) must belong to exactly one listed position. A point p lies on
the representative of a position with triplet x -> R x + t when
R g p + t - g p is a lattice vector for some operation g and its site
group has the position’s order, the test spglib uses (A. Togo, K. Shinohara
and I. Tanaka, Sci. Technol. Adv. Mater. Meth. 4, 2384822 (2024)).
Module Attributes
Position letters in the order of the International Tables ( |
Functions
|
Each site's Wyckoff position, free parameters and orbit, for previews (#229). |
|
Problems found when the table is compared with the computed orbits (empty: none). |
|
A setting and its Wyckoff positions, for the SDK, CLI, REST and MCP. |
|
The lattice parameters a crystal of this setting takes; the system fixes the rest. |
|
|
|
The Wyckoff position of a point and its free parameters on the representative. |
|
A triplet's (R, t) with t reduced to [0, 1): equal keys name the same points. |
|
The distinct images of a point in the conventional cell, wrapped into [0, 1). |
|
The symbolic orbit of a coordinate triplet under every operation (with centring). |
|
|
|
A position by letter, |
|
The Wyckoff positions of a setting, from |
Forget the loaded table (the generator rewrites it). |
|
|
Fractional coordinates of a Wyckoff site, e.g. |
Classes
|
One Wyckoff position of a setting: |
- vibesketcher.document.wyckoff.LETTERS = 'abcdefghijklmnopqrstuvwxyzA'¶
Position letters in the order of the International Tables (
Astands for alpha).
- vibesketcher.document.wyckoff.parse_triplet(text)[source]¶
"x,2x,1/4"as the affine map (R, t) of the free coordinates x, y, z.
- vibesketcher.document.wyckoff.normalise_triplet(text)[source]¶
A triplet’s (R, t) with t reduced to [0, 1): equal keys name the same points.
- class vibesketcher.document.wyckoff.WyckoffPosition(letter, multiplicity, site_symmetry, triplet)[source]¶
Bases:
objectOne Wyckoff position of a setting:
12cwith site symmetry3.at0,0,z.- property affine: tuple[tuple[tuple[int, int, int], tuple[int, int, int], tuple[int, int, int]], tuple[Fraction, Fraction, Fraction]][source]¶
- property free: tuple[str, ...][source]¶
The free parameters, in x, y, z order (empty for a fixed position).
- vibesketcher.document.wyckoff.reset_cache()[source]¶
Forget the loaded table (the generator rewrites it).
- Return type:
None
- vibesketcher.document.wyckoff.positions(symbol)[source]¶
The Wyckoff positions of a setting, from
ato the general position.- Parameters:
- Return type:
- vibesketcher.document.wyckoff.position(symbol, letter)[source]¶
A position by letter,
c, or by multiplicity and letter,12c.- Parameters:
- Return type:
- vibesketcher.document.wyckoff.site(symbol, letter, values=None)[source]¶
Fractional coordinates of a Wyckoff site, e.g.
site("R-3c", "12c", {"z": 0.352}).
- vibesketcher.document.wyckoff.orbit(symbol, point, tolerance=0.0001)[source]¶
The distinct images of a point in the conventional cell, wrapped into [0, 1).
- vibesketcher.document.wyckoff.orbit_triplets(symbol, triplet)[source]¶
The symbolic orbit of a coordinate triplet under every operation (with centring).
- vibesketcher.document.wyckoff.identify(symbol, point, tolerance=0.0001)[source]¶
The Wyckoff position of a point and its free parameters on the representative.
toleranceis in fractional coordinates. The parameters are those of the first orbit image that lies on the position’s coordinate triplet.
- vibesketcher.document.wyckoff.free_cell_parameters(symbol)[source]¶
The lattice parameters a crystal of this setting takes; the system fixes the rest.
- vibesketcher.document.wyckoff.describe(symbol)[source]¶
A setting and its Wyckoff positions, for the SDK, CLI, REST and MCP.
- vibesketcher.document.wyckoff.check_setting(symbol)[source]¶
Problems found when the table is compared with the computed orbits (empty: none).
Exact integer arithmetic on the 1/24 grid: operations and triplets are scaled by 24, so every comparison is modulo 24.