stjames 0.0.90__tar.gz → 0.0.92__tar.gz

{stjames-0.0.90/stjames.egg-info → stjames-0.0.92}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stjames
-Version: 0.0.90
+Version: 0.0.92
 Summary: standardized JSON atom/molecule encoding scheme
 Author-email: Corin Wagen <corin@rowansci.com>
 Project-URL: Homepage, https://github.com/rowansci/stjames

{stjames-0.0.90 → stjames-0.0.92}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "stjames"
-version = "0.0.90"
+version = "0.0.92"
 description = "standardized JSON atom/molecule encoding scheme"
 readme = "README.md"
 requires-python = ">=3.11"

stjames-0.0.92/stjames/engine.py

@@ -0,0 +1,16 @@
+from .base import LowercaseStrEnum
+
+
+class Mode(LowercaseStrEnum):
+    AIMNET2 = "aimnet2"
+    MACE = "mace"
+    OCP24 = "ocp24"
+    OMOL25 = "omol25"
+    ORB = "orb"
+    TBLITE = "tblite"
+    XTB = "xtb"
+    TERRACHEM = "terrachem"
+    PYSCF = "pyscf"
+    PSI4 = "psi4"
+    OPENFF = "openff"
+    EGRET = "egret"

{stjames-0.0.90 → stjames-0.0.92}/stjames/method.py

@@ -37,7 +37,7 @@ class Method(LowercaseStrEnum):
     OCP24_L = "ocp24_l"
     OMOL25_CONSERVING_S = "omol25_conserving_s"
     UMA_M_OMOL = "uma_m_omol"
-    ORB_V2 = "orb_v2"
+    UMA_S_OMOL = "uma_s_omol"
     ORB_V3_CONSERVATIVE_INF_OMAT = "orb_v3_conservative_inf_omat"
 
     GFN_FF = "gfn_ff"
@@ -51,12 +51,53 @@ class Method(LowercaseStrEnum):
 
     OFF_SAGE_2_2_1 = "off_sage_2_2_1"
 
-    RM1 = "rm1"
-
     EGRET_1 = "egret_1"
     EGRET_1E = "egret_1e"
     EGRET_1T = "egret_1t"
 
+    def default_engine(self, *, is_periodic: bool = False) -> str:
+        """
+        Return the canonical engine name for this quantum-chemistry method.
+
+        :param bool is_periodic:
+            If ``True`` **and** the method is in the XTB family, return
+            ``"tblite"`` (periodic-capable backend) instead of ``"xtb"``.
+        :returns: Lower-case engine identifier (e.g. ``"psi4"``, ``"mace"``).
+
+        **Examples**
+
+        .. code-block:: python
+
+           Method.MACE_MP_0B2_L.default_engine()
+           # 'mace'
+
+           Method.GFN2_XTB.default_engine()
+           # 'xtb'
+
+           Method.GFN2_XTB.default_engine(is_periodic=True)
+           # 'tblite'
+        """
+        match self:
+            case Method.AIMNET2_WB97MD3:
+                return "aimnet2"
+            case Method.MACE_MP_0B2_L:
+                return "mace"
+            case Method.OCP24_S | Method.OCP24_L:
+                return "ocp24"
+            case Method.OMOL25_CONSERVING_S | Method.UMA_M_OMOL | Method.UMA_S_OMOL:
+                return "omol25"
+            case Method.ORB_V3_CONSERVATIVE_INF_OMAT:
+                return "orb"
+            case _ if self in XTB_METHODS:
+                return "tblite" if is_periodic else "xtb"
+            case Method.OFF_SAGE_2_2_1:
+                return "openff"
+            case Method.EGRET_1 | Method.EGRET_1E | Method.EGRET_1T:
+                return "egret"
+            case _:
+                # All remaining methods (HF, DFT, composite, etc.) fall back to Psi4
+                return "psi4"
+
 
 PrepackagedNNPMethod = Literal[
     Method.AIMNET2_WB97MD3,
@@ -64,7 +105,7 @@ PrepackagedNNPMethod = Literal[
     Method.OCP24_L,
     Method.OMOL25_CONSERVING_S,
     Method.UMA_M_OMOL,
-    Method.RM1,
+    Method.UMA_S_OMOL,
     Method.ORB_V3_CONSERVATIVE_INF_OMAT,
     Method.EGRET_1,
     Method.EGRET_1E,
@@ -77,15 +118,15 @@ PREPACKAGED_NNP_METHODS = [
     Method.OCP24_L,
     Method.OMOL25_CONSERVING_S,
     Method.UMA_M_OMOL,
-    Method.RM1,
+    Method.UMA_S_OMOL,
     Method.ORB_V3_CONSERVATIVE_INF_OMAT,
     Method.EGRET_1,
     Method.EGRET_1E,
     Method.EGRET_1T,
 ]
 
-CorrectableNNPMethod = Literal[Method.MACE_MP_0B2_L, Method.ORB_V2]
-CORRECTABLE_NNP_METHODS = [Method.MACE_MP_0B2_L, Method.ORB_V2]
+CorrectableNNPMethod = Literal[Method.MACE_MP_0B2_L]
+CORRECTABLE_NNP_METHODS = [Method.MACE_MP_0B2_L]
 
 NNPMethod = PrepackagedNNPMethod | CorrectableNNPMethod
 NNP_METHODS = [*PREPACKAGED_NNP_METHODS, *CORRECTABLE_NNP_METHODS]

{stjames-0.0.90 → stjames-0.0.92/stjames.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stjames
-Version: 0.0.90
+Version: 0.0.92
 Summary: standardized JSON atom/molecule encoding scheme
 Author-email: Corin Wagen <corin@rowansci.com>
 Project-URL: Homepage, https://github.com/rowansci/stjames

{stjames-0.0.90 → stjames-0.0.92}/stjames.egg-info/SOURCES.txt

@@ -11,6 +11,7 @@ stjames/compute_settings.py
 stjames/constraint.py
 stjames/correction.py
 stjames/diis_settings.py
+stjames/engine.py
 stjames/grid_settings.py
 stjames/int_settings.py
 stjames/message.py