Substrates now using string and numeric query op

materialsproject · May 28, 2021 · d572c09 · d572c09
1 parent 8172602
commit d572c09
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 21 deletions.
diff --git a/src/mp_api/routes/substrates/query_operators.py b/src/mp_api/routes/substrates/query_operators.py
@@ -13,28 +13,18 @@ class SubstrateStructureQuery(QueryOperator):
 
     def query(
         self,
-        film_id: Optional[str] = Query(None, description="Materials Project ID of the film material.",),
-        substrate_id: Optional[str] = Query(None, description="Materials Project ID of the substrate material.",),
-        substrate_formula: Optional[str] = Query(None, description="Reduced formula of the substrate material.",),
         film_orientation: Optional[str] = Query(
-            None, description="Comma separated integers defining the film surface orientation.",
+            None,
+            description="Comma separated integers defining the film surface orientation.",
         ),
         substrate_orientation: Optional[str] = Query(
-            None, description="Comma separated integers defining the substrate surface orientation.",
+            None,
+            description="Comma separated integers defining the substrate surface orientation.",
         ),
     ) -> STORE_PARAMS:
 
         crit = defaultdict(dict)  # type: dict
 
-        if film_id:
-            crit["film_id"] = film_id
-
-        if substrate_id:
-            crit["sub_id"] = substrate_id
-
-        if substrate_formula:
-            crit["sub_form"] = substrate_formula
-
         if film_orientation:
             crit["film_orient"] = film_orientation.replace(",", " ")
 
@@ -57,13 +47,19 @@ class EnergyAreaQuery(QueryOperator):
     def query(
         self,
         area_max: Optional[float] = Query(
-            None, description="Maximum value for the minimum coincident interface area in Å².",
+            None,
+            description="Maximum value for the minimum coincident interface area in Å².",
         ),
         area_min: Optional[float] = Query(
-            None, description="Minimum value for the minimum coincident interface area in Å².",
+            None,
+            description="Minimum value for the minimum coincident interface area in Å².",
+        ),
+        energy_max: Optional[float] = Query(
+            None, description="Maximum value for the energy in meV.",
+        ),
+        energy_min: Optional[float] = Query(
+            None, description="Minimum value for the energy in meV.",
         ),
-        energy_max: Optional[float] = Query(None, description="Maximum value for the energy in meV.",),
-        energy_min: Optional[float] = Query(None, description="Minimum value for the energy in meV.",),
     ) -> STORE_PARAMS:
 
         crit = defaultdict(dict)  # type: dict

diff --git a/src/mp_api/routes/substrates/resources.py b/src/mp_api/routes/substrates/resources.py
@@ -1,8 +1,14 @@
 from maggma.api.resource import ReadOnlyResource
 from mp_api.routes.substrates.models import SubstratesDoc
 
-from maggma.api.query_operator import PaginationQuery, SortQuery, SparseFieldsQuery
-from mp_api.routes.substrates.query_operators import SubstrateStructureQuery, EnergyAreaQuery
+from maggma.api.query_operator import (
+    PaginationQuery,
+    SortQuery,
+    SparseFieldsQuery,
+    NumericQuery,
+    StringQueryOperator,
+)
+from mp_api.routes.substrates.query_operators import SubstrateStructureQuery
 
 
 def substrates_resource(substrates_store):
@@ -11,7 +17,10 @@ def substrates_resource(substrates_store):
         SubstratesDoc,
         query_operators=[
             SubstrateStructureQuery(),
-            EnergyAreaQuery(),
+            NumericQuery(model=SubstratesDoc),
+            StringQueryOperator(
+                model=SubstratesDoc, excluded_fields=["film_orient", "orient"]
+            ),
             SortQuery(),
             PaginationQuery(),
             SparseFieldsQuery(SubstratesDoc, default_fields=["film_id", "sub_id"]),