httk.atomistic.models.formula.wyckoff¶

Formula bridge for Wyckoff-multiplicity-based backends.

Classes¶

WyckoffComposition

Represent the canonical composition of a Wyckoff-multiplicity-based backend.

Module Contents¶

class httk.atomistic.models.formula.wyckoff.WyckoffComposition(obj, **hints)[source]¶

Bases: httk.atomistic.models.formula.backend.ChemicalFormulaBackend

Represent the canonical composition of a Wyckoff-multiplicity-based backend.

Anonymous-structure and protopattern inputs use anonymous labels; protostructure inputs retain their real elemental composition at the standard conventional-cell scale.

Parameters:

obj (Any) – The anonymous structure or protostructure to present.
**hints (Any) – Backend-selection hints.

kind = 'wyckoff'[source]¶

property is_anonymous: bool[source]¶

Return whether this composition uses anonymous labels.

property amounts: tuple[tuple[str, fractions.Fraction], Ellipsis][source]¶

Return the canonical composition amounts.

property uncertainties: tuple[tuple[str, fractions.Fraction | None], Ellipsis][source]¶

Return the composition amount precisions.

property complete: bool[source]¶

Return whether all represented elemental material is known.

property exact: bool[source]¶

Return whether all composition amounts are exact.

property normalized: bool[source]¶

Return whether the composition is normalized within precision.

property normalization_status: str[source]¶

Return the composition’s normalization status.

property diagnostics[source]¶: Return non-fatal diagnostics associated with the composition.

unwrap()[source]¶

Return the raw object behind the Wyckoff-composition backend.

Returns:: The unwrapped source object.
Return type:: Any