httk.atomistic.entries.moments

Serve structure site moments as Cartesian JSON values.

Attributes

MOMENT_PROPERTY_KEYS

Functions

moment_definitions()	Load the vendored site-moment property definition.
moment_properties(structure)	Project non-collinear site moments as Cartesian JSON values.

Module Contents

httk.atomistic.entries.moments.MOMENT_PROPERTY_KEYS: dict[str, str]

httk.atomistic.entries.moments.moment_definitions()

Load the vendored site-moment property definition.

Returns:

The definition keyed by _httk_site_moments.

Return type:

dict[str, httk.core.PropertyDefinition]

httk.atomistic.entries.moments.moment_properties(structure)

Project non-collinear site moments as Cartesian JSON values.

Parameters:

structure (Any) – The structure to project, or None for an empty entry.

Returns:

The _httk_site_moments value, or None when unavailable or collinear.

Return type:

dict[str, Any]