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
|
from __future__ import annotations
from collections import defaultdict
from emmet.core.molecules_jcesr import MoleculesDoc
from pymatgen.core.periodic_table import Element
from mp_api.client.core import BaseRester
from mp_api.client.core.utils import validate_ids
class JcesrMoleculesRester(BaseRester[MoleculesDoc]):
suffix = "molecules/jcesr"
document_model = MoleculesDoc # type: ignore
primary_key = "task_id"
def search(
self,
task_ids: str | list[str] | None = None,
charge: tuple[float, float] | None = None,
elements: list[Element] | None = None,
EA: tuple[float, float] | None = None,
IE: tuple[float, float] | None = None,
nelements: tuple[float, float] | None = None,
pointgroup: str | None = None,
smiles: str | None = None,
num_chunks: int | None = None,
chunk_size: int = 1000,
all_fields: bool = True,
fields: list[str] | None = None,
):
"""Query equations of state docs using a variety of search criteria.
Arguments:
task_ids (str, List[str]): A single molecule task ID string or list of strings.
(e.g., mol-45004, [mol-45004, mol-45228]).
charge (Tuple[float,float]): Minimum and maximum value of the charge in +e to consider.
elements (List[Element]): A list of elements.
film_orientation (List[Elements]): List of elements that are in the molecule.
EA (Tuple[float,float]): Minimum and maximum value of the electron affinity in eV to consider.
IE (Tuple[float,float]): Minimum and maximum value of the ionization energy in eV to consider.
nelements (Tuple[float,float]): Minimum and maximum number of elements in the molecule to consider.
pointgroup (str): Point group of the molecule in Schoenflies notation.
smiles (str): The simplified molecular input line-entry system (SMILES) representation of the molecule.
num_chunks (int): Maximum number of chunks of data to yield. None will yield all possible.
chunk_size (int): Number of data entries per chunk.
all_fields (bool): Whether to return all fields in the document. Defaults to True.
fields (List[str]): List of fields in MoleculesDoc to return data for.
Default is the material_id only if all_fields is False.
Returns:
([MoleculesDoc]) List of molecule documents
"""
query_params = defaultdict(dict) # type: dict
if task_ids:
if isinstance(task_ids, str):
task_ids = [task_ids]
query_params.update({"task_ids": ",".join(validate_ids(task_ids))})
if elements:
query_params.update({"elements": ",".join([str(ele) for ele in elements])})
if pointgroup:
query_params.update({"pointgroup": pointgroup})
if smiles:
query_params.update({"smiles": smiles})
if nelements:
query_params.update(
{"nelements_min": nelements[0], "nelements_max": nelements[1]}
)
if EA:
query_params.update({"EA_min": EA[0], "EA_max": EA[1]})
if IE:
query_params.update({"IE_min": IE[0], "IE_max": IE[1]})
if charge:
query_params.update({"charge_min": charge[0], "charge_max": charge[1]})
query_params = {
entry: query_params[entry]
for entry in query_params
if query_params[entry] is not None
}
return super()._search(
num_chunks=num_chunks,
chunk_size=chunk_size,
all_fields=all_fields,
fields=fields,
**query_params,
)
|
