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 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543
|
""" Core definition of a Molecule Document """
from typing import Any, Dict, List, Mapping, Union, Optional
from pydantic import Field
from pymatgen.core.structure import Molecule
from pymatgen.analysis.molecule_matcher import MoleculeMatcher
from pymatgen.io.babel import BabelMolAdaptor
from emmet.core.mpid import MPculeID
from emmet.core.utils import get_graph_hash, get_molecule_id
from emmet.core.settings import EmmetSettings
from emmet.core.material import CoreMoleculeDoc, PropertyOrigin
from emmet.core.qchem.calc_types import CalcType, LevelOfTheory, TaskType
from emmet.core.qchem.task import TaskDocument
try:
import openbabel
except ImportError:
openbabel = None
__author__ = "Evan Spotte-Smith <ewcspottesmith@lbl.gov>"
SETTINGS = EmmetSettings()
def evaluate_lot(
lot: Union[LevelOfTheory, str],
funct_scores: Dict[str, int] = SETTINGS.QCHEM_FUNCTIONAL_QUALITY_SCORES,
basis_scores: Dict[str, int] = SETTINGS.QCHEM_BASIS_QUALITY_SCORES,
solvent_scores: Dict[str, int] = SETTINGS.QCHEM_SOLVENT_MODEL_QUALITY_SCORES,
):
"""
Score the various components of a level of theory (functional, basis set,
and solvent model), where a lower score is better than a higher score.
:param lot: Level of theory to be evaluated
:param funct_scores: Scores for various density functionals
:param basis_scores: Scores for various basis sets
:param solvent_scores: Scores for various implicit solvent models
:return:
"""
if isinstance(lot, LevelOfTheory):
lot_comp = lot.value.split("/")
else:
lot_comp = lot.split("/")
return (
-1 * funct_scores.get(lot_comp[0], 0),
-1 * basis_scores.get(lot_comp[1], 0),
-1 * solvent_scores.get(lot_comp[2], 0),
)
def evaluate_task(
task: TaskDocument,
funct_scores: Dict[str, int] = SETTINGS.QCHEM_FUNCTIONAL_QUALITY_SCORES,
basis_scores: Dict[str, int] = SETTINGS.QCHEM_BASIS_QUALITY_SCORES,
solvent_scores: Dict[str, int] = SETTINGS.QCHEM_SOLVENT_MODEL_QUALITY_SCORES,
task_quality_scores: Dict[str, int] = SETTINGS.QCHEM_TASK_QUALITY_SCORES,
):
"""
Helper function to order optimization calcs by
- Level of theory
- Electronic energy
Note that lower scores indicate a higher quality.
:param task: Task to be evaluated
:param funct_scores: Scores for various density functionals
:param basis_scores: Scores for various basis sets
:param solvent_scores: Scores for various implicit solvent models
:param task_quality_scores: Scores for various task types
:return: tuple representing different levels of evaluation:
- Task validity
- Level of theory score
- Task score
- Electronic energy
"""
lot = task.level_of_theory
lot_eval = evaluate_lot(
lot,
funct_scores=funct_scores,
basis_scores=basis_scores,
solvent_scores=solvent_scores,
)
return (
-1 * int(task.is_valid),
sum(lot_eval),
-1 * task_quality_scores.get(task.task_type.value, 0),
task.output.final_energy,
)
def evaluate_task_entry(
entry: Dict[str, Any],
funct_scores: Dict[str, int] = SETTINGS.QCHEM_FUNCTIONAL_QUALITY_SCORES,
basis_scores: Dict[str, int] = SETTINGS.QCHEM_BASIS_QUALITY_SCORES,
solvent_scores: Dict[str, int] = SETTINGS.QCHEM_SOLVENT_MODEL_QUALITY_SCORES,
task_quality_scores: Dict[str, int] = SETTINGS.QCHEM_TASK_QUALITY_SCORES,
):
"""
Helper function to order optimization calcs by
- Level of theory
- Electronic energy
Note that lower scores indicate a higher quality.
:param task: Task to be evaluated
:param funct_scores: Scores for various density functionals
:param basis_scores: Scores for various basis sets
:param solvent_scores: Scores for various implicit solvent models
:param task_quality_scores: Scores for various task types
:return: tuple representing different levels of evaluation:
- Level of theory score
- Task score
- Electronic energy
"""
lot = entry["level_of_theory"]
lot_eval = evaluate_lot(
lot,
funct_scores=funct_scores,
basis_scores=basis_scores,
solvent_scores=solvent_scores,
)
return (
sum(lot_eval),
-1 * task_quality_scores.get(entry["task_type"], 0),
entry["energy"],
)
class MoleculeDoc(CoreMoleculeDoc):
species: Optional[List[str]] = Field(
None, description="Ordered list of elements/species in this Molecule."
)
molecules: Optional[Dict[str, Molecule]] = Field(
None,
description="The lowest energy optimized structures for this molecule for each solvent.",
)
molecule_levels_of_theory: Optional[Dict[str, str]] = Field(
None,
description="Level of theory used to optimize the best molecular structure for each solvent.",
)
species_hash: Optional[str] = Field(
None,
description="Weisfeiler Lehman (WL) graph hash using the atom species as the graph "
"node attribute.",
)
coord_hash: Optional[str] = Field(
None,
description="Weisfeiler Lehman (WL) graph hash using the atom coordinates as the graph "
"node attribute.",
)
inchi: Optional[str] = Field(
None, description="International Chemical Identifier (InChI) for this molecule"
)
inchi_key: Optional[str] = Field(
None, description="Standardized hash of the InChI for this molecule"
)
calc_types: Optional[Mapping[str, CalcType]] = Field( # type: ignore
None,
description="Calculation types for all the calculations that make up this molecule",
)
task_types: Optional[Mapping[str, TaskType]] = Field(
None,
description="Task types for all the calculations that make up this molecule",
)
levels_of_theory: Optional[Mapping[str, LevelOfTheory]] = Field(
None,
description="Levels of theory types for all the calculations that make up this molecule",
)
solvents: Optional[Mapping[str, str]] = Field(
None,
description="Solvents (solvent parameters) for all the calculations that make up this molecule",
)
lot_solvents: Optional[Mapping[str, str]] = Field(
None,
description="Combinations of level of theory and solvent for all calculations that make up this molecule",
)
unique_calc_types: Optional[List[CalcType]] = Field(
None,
description="Collection of all unique calculation types used for this molecule",
)
unique_task_types: Optional[List[TaskType]] = Field(
None,
description="Collection of all unique task types used for this molecule",
)
unique_levels_of_theory: Optional[List[LevelOfTheory]] = Field(
None,
description="Collection of all unique levels of theory used for this molecule",
)
unique_solvents: Optional[List[str]] = Field(
None,
description="Collection of all unique solvents (solvent parameters) used for this molecule",
)
unique_lot_solvents: Optional[List[str]] = Field(
None,
description="Collection of all unique combinations of level of theory and solvent used for this molecule",
)
origins: Optional[List[PropertyOrigin]] = Field(
None,
description="List of property origins for tracking the provenance of properties",
)
entries: Optional[List[Dict[str, Any]]] = Field(
None,
description="Dictionary representations of all task documents for this molecule",
)
best_entries: Optional[Mapping[str, Dict[str, Any]]] = Field(
None,
description="Mapping for tracking the best entries at each level of theory (+ solvent) for Q-Chem calculations",
)
constituent_molecules: Optional[List[MPculeID]] = Field(
None,
description="For cases where data from multiple MoleculeDocs have been compiled, a list of "
"MPculeIDs of documents used to construct this document",
)
similar_molecules: Optional[List[MPculeID]] = Field(
None,
description="List of MPculeIDs with of molecules similar (by e.g. structure) to this one",
)
@classmethod
def from_tasks(
cls,
task_group: List[TaskDocument],
) -> "MoleculeDoc":
"""
Converts a group of tasks into one molecule document
Args:
task_group: List of task document
"""
if openbabel is None:
raise ModuleNotFoundError(
"openbabel must be installed to instantiate a MoleculeDoc from tasks"
)
if len(task_group) == 0:
raise Exception("Must have more than one task in the group.")
entries = [t.entry for t in task_group]
# Metadata
last_updated = max(task.last_updated for task in task_group)
created_at = min(task.last_updated for task in task_group)
task_ids = list({task.task_id for task in task_group})
deprecated_tasks = {task.task_id for task in task_group if not task.is_valid}
levels_of_theory = {task.task_id: task.level_of_theory for task in task_group}
solvents = {task.task_id: task.solvent for task in task_group}
lot_solvents = {task.task_id: task.lot_solvent for task in task_group}
task_types = {task.task_id: task.task_type for task in task_group}
calc_types = {task.task_id: task.calc_type for task in task_group}
unique_lots = list(set(levels_of_theory.values()))
unique_solvents = list(set(solvents.values()))
unique_lot_solvents = list(set(lot_solvents.values()))
unique_task_types = list(set(task_types.values()))
unique_calc_types = list(set(calc_types.values()))
mols = [task.output.initial_molecule for task in task_group]
# If we're dealing with single-atoms, process is much different
if all([len(m) == 1 for m in mols]):
sorted_tasks = sorted(task_group, key=evaluate_task)
molecule = sorted_tasks[0].output.initial_molecule
species = [e.symbol for e in molecule.species]
molecule_id = get_molecule_id(molecule, node_attr="coords")
# Initial molecules. No geometry should change for a single atom
initial_molecules = [molecule]
# Deprecated
deprecated = all(task.task_id in deprecated_tasks for task in task_group)
# Origins
origins = [
PropertyOrigin(
name="molecule",
task_id=sorted_tasks[0].task_id,
last_updated=sorted_tasks[0].last_updated,
)
]
# entries
best_entries = dict()
for lot_solv in unique_lot_solvents:
relevant_calcs = sorted(
[
doc
for doc in task_group
if doc.lot_solvent == lot_solv and doc.is_valid
],
key=evaluate_task,
)
if len(relevant_calcs) > 0:
best_task_doc = relevant_calcs[0]
entry = best_task_doc.entry
best_entries[lot_solv] = entry
else:
geometry_optimizations = [
task
for task in task_group
if task.task_type
in [
TaskType.Geometry_Optimization,
TaskType.Frequency_Flattening_Geometry_Optimization,
"Geometry Optimization",
"Frequency Flattening Geometry Optimization",
] # noqa: E501
]
try:
best_molecule_calc = sorted(geometry_optimizations, key=evaluate_task)[
0
]
except IndexError:
raise Exception("No geometry optimization calculations available!")
molecule = best_molecule_calc.output.optimized_molecule
species = [e.symbol for e in molecule.species]
molecule_id = get_molecule_id(molecule, node_attr="coords")
# Initial molecules
initial_molecules = list()
for task in task_group:
if isinstance(task.orig["molecule"], Molecule):
initial_molecules.append(task.orig["molecule"])
else:
initial_molecules.append(Molecule.from_dict(task.orig["molecule"]))
mm = MoleculeMatcher()
initial_molecules = [
group[0] for group in mm.group_molecules(initial_molecules)
]
# Deprecated
deprecated = all(
task.task_id in deprecated_tasks for task in geometry_optimizations
)
deprecated = deprecated or best_molecule_calc.task_id in deprecated_tasks
# Origins
origins = [
PropertyOrigin(
name="molecule",
task_id=best_molecule_calc.task_id,
last_updated=best_molecule_calc.last_updated,
)
]
# entries
best_entries = dict()
all_lot_solvs = set(lot_solvents.values())
for lot_solv in all_lot_solvs:
relevant_calcs = sorted(
[
doc
for doc in geometry_optimizations
if doc.lot_solvent == lot_solv and doc.is_valid
],
key=evaluate_task,
)
if len(relevant_calcs) > 0:
best_task_doc = relevant_calcs[0]
entry = best_task_doc.entry
best_entries[lot_solv] = entry
for entry in entries:
entry["entry_id"] = molecule_id
species_hash = get_graph_hash(molecule, "specie")
coord_hash = get_graph_hash(molecule, "coords")
ad = BabelMolAdaptor(molecule)
openbabel.StereoFrom3D(ad.openbabel_mol)
inchi = ad.pybel_mol.write("inchi").strip() # type: ignore[attr-defined]
inchikey = ad.pybel_mol.write("inchikey").strip() # type: ignore[attr-defined]
return cls.from_molecule(
molecule=molecule,
molecule_id=molecule_id,
species=species,
species_hash=species_hash,
coord_hash=coord_hash,
inchi=inchi,
inchi_key=inchikey,
initial_molecules=initial_molecules,
last_updated=last_updated,
created_at=created_at,
task_ids=task_ids,
calc_types=calc_types,
levels_of_theory=levels_of_theory,
solvents=solvents,
lot_solvents=lot_solvents,
task_types=task_types,
unique_levels_of_theory=unique_lots,
unique_solvents=unique_solvents,
unique_lot_solvents=unique_lot_solvents,
unique_task_types=unique_task_types,
unique_calc_types=unique_calc_types,
deprecated=deprecated,
deprecated_tasks=deprecated_tasks,
origins=origins,
entries=entries,
best_entries=best_entries,
)
@classmethod
def construct_deprecated_molecule(
cls,
task_group: List[TaskDocument],
) -> "MoleculeDoc":
"""
Converts a group of tasks into a deprecated molecule document
Args:
task_group: List of task document
"""
if len(task_group) == 0:
raise Exception("Must have more than one task in the group.")
# Metadata
last_updated = max(task.last_updated for task in task_group)
created_at = min(task.last_updated for task in task_group)
task_ids = list({task.task_id for task in task_group})
deprecated_tasks = {task.task_id for task in task_group}
levels_of_theory = {task.task_id: task.level_of_theory for task in task_group}
solvents = {task.task_id: task.solvent for task in task_group}
lot_solvents = {task.task_id: task.lot_solvent for task in task_group}
task_types = {task.task_id: task.task_type for task in task_group}
calc_types = {task.task_id: task.calc_type for task in task_group}
unique_lots = list(set(levels_of_theory.values()))
unique_solvents = list(set(solvents.values()))
unique_lot_solvents = list(set(lot_solvents.values()))
unique_task_types = list(set(task_types.values()))
unique_calc_types = list(set(calc_types.values()))
# Arbitrarily choose task with lowest ID
molecule = sorted(task_group, key=lambda x: x.task_id)[
0
].output.initial_molecule
species = [e.symbol for e in molecule.species]
# Molecule ID
molecule_id = get_molecule_id(molecule, "coords")
species_hash = get_graph_hash(molecule, "specie")
coord_hash = get_graph_hash(molecule, "coords")
ad = BabelMolAdaptor(molecule)
openbabel.StereoFrom3D(ad.openbabel_mol)
inchi = ad.pybel_mol.write("inchi").strip() # type: ignore[attr-defined]
inchikey = ad.pybel_mol.write("inchikey").strip() # type: ignore[attr-defined]
return cls.from_molecule(
molecule=molecule,
molecule_id=molecule_id,
species=species,
species_hash=species_hash,
coord_hash=coord_hash,
inchi=inchi,
inchi_key=inchikey,
last_updated=last_updated,
created_at=created_at,
task_ids=task_ids,
calc_types=calc_types,
levels_of_theory=levels_of_theory,
solvents=solvents,
lot_solvents=lot_solvents,
task_types=task_types,
unique_levels_of_theory=unique_lots,
unique_solvents=unique_solvents,
unique_lot_solvents=unique_lot_solvents,
unique_task_types=unique_task_types,
unique_calc_types=unique_calc_types,
deprecated=True,
deprecated_tasks=deprecated_tasks,
)
def best_lot(
mol_doc: MoleculeDoc,
funct_scores: Dict[str, int] = SETTINGS.QCHEM_FUNCTIONAL_QUALITY_SCORES,
basis_scores: Dict[str, int] = SETTINGS.QCHEM_BASIS_QUALITY_SCORES,
solvent_scores: Dict[str, int] = SETTINGS.QCHEM_SOLVENT_MODEL_QUALITY_SCORES,
) -> str:
"""
Return the best level of theory used within a MoleculeDoc
:param mol_doc: MoleculeDoc
:param funct_scores: Scores for various density functionals
:param basis_scores: Scores for various basis sets
:param solvent_scores: Scores for various implicit solvent models
:return: string representation of LevelOfTheory
"""
sorted_lots = sorted(
mol_doc.best_entries.keys(), # type: ignore
key=lambda x: evaluate_lot(x, funct_scores, basis_scores, solvent_scores),
)
best = sorted_lots[0]
if isinstance(best, LevelOfTheory):
return best.value
else:
return best
|