1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
|
import copy
import datetime
from enum import Enum
from itertools import groupby
from typing import Any, Dict, Iterator, List, Optional, Union
import numpy as np
from monty.json import MSONable
from pydantic import BaseModel
from pymatgen.analysis.elasticity.strain import Deformation
from pymatgen.analysis.graphs import MoleculeGraph
from pymatgen.analysis.local_env import OpenBabelNN, metal_edge_extender
from pymatgen.analysis.molecule_matcher import MoleculeMatcher
from pymatgen.analysis.structure_matcher import (
AbstractComparator,
ElementComparator,
StructureMatcher,
)
from pymatgen.core.structure import Molecule, Structure
from pymatgen.transformations.standard_transformations import (
DeformStructureTransformation,
)
from pymatgen.util.graph_hashing import weisfeiler_lehman_graph_hash
from emmet.core.mpid import MPculeID
from emmet.core.settings import EmmetSettings
try:
import bson
except ImportError:
bson = None # type: ignore
SETTINGS = EmmetSettings()
def get_sg(struc, symprec=SETTINGS.SYMPREC) -> int:
"""helper function to get spacegroup with a loose tolerance"""
try:
return struc.get_space_group_info(symprec=symprec)[1]
except Exception:
return -1
def group_structures(
structures: List[Structure],
ltol: float = SETTINGS.LTOL,
stol: float = SETTINGS.STOL,
angle_tol: float = SETTINGS.ANGLE_TOL,
symprec: float = SETTINGS.SYMPREC,
comparator: AbstractComparator = ElementComparator(),
) -> Iterator[List[Structure]]:
"""
Groups structures according to space group and structure matching
Args:
structures ([Structure]): list of structures to group
ltol (float): StructureMatcher tuning parameter for matching tasks to materials
stol (float): StructureMatcher tuning parameter for matching tasks to materials
angle_tol (float): StructureMatcher tuning parameter for matching tasks to materials
symprec (float): symmetry tolerance for space group finding
"""
sm = StructureMatcher(
ltol=ltol,
stol=stol,
angle_tol=angle_tol,
primitive_cell=True,
scale=True,
attempt_supercell=False,
allow_subset=False,
comparator=comparator,
)
def _get_sg(struc):
return get_sg(struc, symprec=symprec)
# First group by spacegroup number then by structure matching
for _, pregroup in groupby(sorted(structures, key=_get_sg), key=_get_sg):
for group in sm.group_structures(list(pregroup)):
yield group
def undeform_structure(structure: Structure, transformations: Dict) -> Structure:
"""
Get an undeformed structure by applying transformations in a reverse order.
Args:
structure: deformed structure
transformation: transformation that deforms the structure
Returns:
undeformed structure
"""
for transformation in reversed(transformations.get("history", [])):
if transformation["@class"] == "DeformStructureTransformation":
deform = Deformation(transformation["deformation"])
dst = DeformStructureTransformation(deform.inv)
structure = dst.apply_transformation(structure)
else:
raise RuntimeError(
"Expect transformation to be `DeformStructureTransformation`; "
f"got {transformation['@class']}"
)
return structure
def generate_robocrys_condensed_struct_and_description(
structure: Structure,
mineral_matcher=None,
symprecs: list[float] = [0.01, 0.1, 1.0e-3],
) -> tuple[dict[str, Any], str]:
"""
Get robocrystallographer description of a structure.
Input
------
structure : pymatgen .Structure
mineral_matcher : optional robocrys MineralMatcher object
Slightly reduces load time by storing mineral data
in memory, rather than reloading for each structure.
symprecs : list[float]
A list of symprec values to try for symmetry identification.
The first value is the default used by robocrys, then
the default used by emmet (looser), then a tighter symprec.
Output
-------
A robocrys condensed structure and description.
"""
try:
from robocrys import StructureCondenser, StructureDescriber
except ImportError:
raise ImportError(
"robocrys needs to be installed to generate Robocrystallographer descriptions"
)
for isymprec, symprec in enumerate(symprecs):
# occasionally, symmetry detection fails - give a few chances to modify symprec
try:
condenser = StructureCondenser(
mineral_matcher=mineral_matcher, symprec=symprec
)
condensed_structure = condenser.condense_structure(structure)
break
except ValueError as exc:
if isymprec == len(symprecs) - 1:
raise exc
for desc_fmt in ["unicode", "html", "raw"]:
try:
describer = StructureDescriber(
describe_symmetry_labels=False, fmt=desc_fmt, return_parts=False
)
description = describer.describe(condensed_structure)
break
except ValueError as exc:
# pymatgen won't convert a "subscript period" character to unicode
# in these cases, the description is still generated but unicode
# parsing failed - use html instead
if "subscript period" not in str(exc):
raise exc
return condensed_structure, description
def group_molecules(molecules: List[Molecule]):
"""
Groups molecules according to composition, charge, and equality
Note: this function is (currently) only used in the MoleculesAssociationBuilder.
At that stage, we want to link calculations that are performed on
identical structures. Collapsing similar structures on the basis of e.g.
graph isomorphism happens at a later stage.
Args:
molecules (List[Molecule])
"""
def _mol_form(mol_solv):
return mol_solv.composition.alphabetical_formula
# Extremely tight tolerance is desirable
# We want to match only calculations that are EXACTLY the same
# Molecules with slight differences in bonding (which might be caused by, for instance,
# different solvent environments)
# This tolerance was chosen based on trying to distinguish CO optimized in
# two different solvents
mm = MoleculeMatcher(tolerance=0.000001)
# First, group by formula
# Hopefully this step is unnecessary - builders should already be doing this
for mol_key, pregroup in groupby(sorted(molecules, key=_mol_form), key=_mol_form):
groups: List[Dict[str, Any]] = list()
for mol in pregroup:
mol_copy = copy.deepcopy(mol)
# Single atoms could always have identical structure
# So grouping by geometry isn't enough
# Need to also group by charge
if len(mol_copy) > 1:
mol_copy.set_charge_and_spin(0)
matched = False
# Group by structure
for group in groups:
if (
(mm.fit(mol_copy, group["mol"]) or mol_copy == group["mol"])
and mol_copy.charge == group["mol"].charge
and mol_copy.spin_multiplicity == group["mol"].spin_multiplicity
):
group["mol_list"].append(mol)
matched = True
break
if not matched:
groups.append({"mol": mol_copy, "mol_list": [mol]})
for group in groups:
yield group["mol_list"]
def confirm_molecule(mol: Union[Molecule, Dict]):
"""
Check that something that we expect to be a molecule is actually a Molecule
object, and not a dictionary representation.
:param mol (Molecule):
:return:
"""
if isinstance(mol, Dict):
return Molecule.from_dict(mol)
else:
return mol
def make_mol_graph(
mol: Molecule, critic_bonds: Optional[List[List[int]]] = None
) -> MoleculeGraph:
"""
Construct a MoleculeGraph using OpenBabelNN with metal_edge_extender and
(optionally) Critic2 bonding information.
This bonding scheme was used to define bonding for the Lithium-Ion Battery
Electrolyte (LIBE) dataset (DOI: 10.1038/s41597-021-00986-9)
:param mol: Molecule to be converted to MoleculeGraph
:param critic_bonds: (optional) List of lists [a, b], where a and b are
atom indices (0-indexed)
:return: mol_graph, a MoleculeGraph
"""
mol_graph = MoleculeGraph.with_local_env_strategy(mol, OpenBabelNN())
mol_graph = metal_edge_extender(mol_graph)
if critic_bonds:
mg_edges = mol_graph.graph.edges()
for bond in critic_bonds:
bond.sort()
if bond[0] != bond[1]:
bond_tup = (bond[0], bond[1])
if bond_tup not in mg_edges:
mol_graph.add_edge(bond_tup[0], bond_tup[1])
return mol_graph
def get_graph_hash(mol: Molecule, node_attr: Optional[str] = None):
"""
Return the Weisfeiler Lehman (WL) graph hash of the MoleculeGraph described
by this molecule, using the OpenBabelNN strategy with extension for
metal coordinate bonds
:param mol: Molecule
:param node_attr: Node attribute to be used to compute the WL hash
:return: string of the WL graph hash
"""
mg = make_mol_graph(mol)
return weisfeiler_lehman_graph_hash(
mg.graph.to_undirected(),
node_attr=node_attr,
)
def get_molecule_id(mol: Molecule, node_attr: Optional[str] = None):
"""
Return an MPculeID for a molecule, with the hash component
based on a particular attribute of the molecule graph representation.
:param mol: Molecule
:param node_attr:Node attribute to be used to compute the WL hash
:return: MPculeID
"""
graph_hash = get_graph_hash(mol, node_attr=node_attr)
return MPculeID(
"{}-{}-{}-{}".format(
graph_hash,
mol.composition.alphabetical_formula.replace(" ", ""),
str(int(mol.charge)).replace("-", "m"),
str(mol.spin_multiplicity),
)
)
def jsanitize(obj, strict=False, allow_bson=False):
"""
This method cleans an input json-like object, either a list or a dict or
some sequence, nested or otherwise, by converting all non-string
dictionary keys (such as int and float) to strings, and also recursively
encodes all objects using Monty's as_dict() protocol.
Args:
obj: input json-like object.
strict (bool): This parameters sets the behavior when jsanitize
encounters an object it does not understand. If strict is True,
jsanitize will try to get the as_dict() attribute of the object. If
no such attribute is found, an attribute error will be thrown. If
strict is False, jsanitize will simply call str(object) to convert
the object to a string representation.
allow_bson (bool): This parameters sets the behavior when jsanitize
encounters an bson supported type such as objectid and datetime. If
True, such bson types will be ignored, allowing for proper
insertion into MongoDb databases.
Returns:
Sanitized dict that can be json serialized.
"""
if allow_bson and (
isinstance(obj, (datetime.datetime, bytes))
or (bson is not None and isinstance(obj, bson.objectid.ObjectId))
):
return obj
if isinstance(obj, (list, tuple, set)):
return [jsanitize(i, strict=strict, allow_bson=allow_bson) for i in obj]
if np is not None and isinstance(obj, np.ndarray):
return [
jsanitize(i, strict=strict, allow_bson=allow_bson) for i in obj.tolist()
]
if isinstance(obj, Enum):
return obj.value
if isinstance(obj, dict):
return {
k.__str__(): jsanitize(v, strict=strict, allow_bson=allow_bson)
for k, v in obj.items()
}
if isinstance(obj, MSONable):
return {
k.__str__(): jsanitize(v, strict=strict, allow_bson=allow_bson)
for k, v in obj.as_dict().items()
}
if isinstance(obj, BaseModel):
return {
k.__str__(): jsanitize(v, strict=strict, allow_bson=allow_bson)
for k, v in obj.model_dump().items()
}
if isinstance(obj, (int, float)):
if np.isnan(obj):
return 0
return obj
if obj is None:
return None
if not strict:
return obj.__str__()
if isinstance(obj, str):
return obj.__str__()
return jsanitize(obj.as_dict(), strict=strict, allow_bson=allow_bson)
class ValueEnum(Enum):
"""
Enum that serializes to string as the value.
While this method has an `as_dict` method, this
returns a `str`. This is to ensure deserialization
to a `str` when functions like `monty.json.jsanitize`
are called on a ValueEnum with `strict = True` and
`enum_values = False` (occurs often in jobflow).
"""
def __str__(self):
return str(self.value)
def __eq__(self, obj: object) -> bool:
"""Special Equals to enable converting strings back to the enum"""
if isinstance(obj, str):
return super().__eq__(self.__class__(obj))
elif isinstance(obj, self.__class__):
return super().__eq__(obj)
return False
def __hash__(self):
"""Get a hash of the enum."""
return hash(str(self))
class DocEnum(ValueEnum):
"""
Enum with docstrings support
from: https://stackoverflow.com/a/50473952
"""
def __new__(cls, value, doc=None):
"""add docstring to the member of Enum if exists
Args:
value: Enum member value
doc: Enum member docstring, None if not exists
"""
self = object.__new__(cls) # calling super().__new__(value) here would fail
self._value_ = value
if doc is not None:
self.__doc__ = doc
return self
class IgnoreCaseEnum(ValueEnum):
"""Enum that permits case-insensitve lookup.
Reference issue:
https://github.com/materialsproject/api/issues/869
"""
@classmethod
def _missing_(cls, value):
for member in cls:
if member.value.upper() == value.upper():
return member
def utcnow() -> datetime.datetime:
"""Get UTC time right now."""
return datetime.datetime.now(datetime.timezone.utc)
|