to_dict#

Cluster.to_dict(
self: Cluster,
xtal_prim: Prim,
phenomenal: Cluster | None = None,
) json#

Represent the Cluster as a Python dict

Parameters:
  • xtal_prim (Prim) – The libcasm.xtal.Prim

  • phenomenal (Optional[Cluster] = None) – For local-clusters, the phenomenal cluster may optionally be provided to include the distances from the phenomenal sites to the local-cluster sites in the output.

Returns:

data – The Cluster as a Python dict

Return type:

dict