stjames 0.0.98__tar.gz → 0.0.99__tar.gz

{stjames-0.0.98/stjames.egg-info → stjames-0.0.99}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stjames
-Version: 0.0.98
+Version: 0.0.99
 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.98 → stjames-0.0.99}/pyproject.toml

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

{stjames-0.0.98 → stjames-0.0.99}/stjames/engine.py

@@ -1,7 +1,7 @@
 from .base import LowercaseStrEnum
 
 
-class Mode(LowercaseStrEnum):
+class Engine(LowercaseStrEnum):
     AIMNET2 = "aimnet2"
     MACE = "mace"
     OCP24 = "ocp24"

{stjames-0.0.98 → stjames-0.0.99}/stjames/method.py

@@ -1,6 +1,7 @@
 from typing import Literal
 
 from .base import LowercaseStrEnum
+from .engine import Engine
 
 
 class Method(LowercaseStrEnum):
@@ -55,48 +56,42 @@ class Method(LowercaseStrEnum):
     EGRET_1E = "egret_1e"
     EGRET_1T = "egret_1t"
 
-    def default_engine(self, *, is_periodic: bool = False) -> str:
+    def default_engine(self, *, is_periodic: bool = False) -> Engine:
         """
-        Return the canonical engine name for this quantum-chemistry method.
+        Return the canonical Engine 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'
+        :returns: lower-case engine identifier (e.g. ``"psi4"``, ``"mace"``).
+
+        >>> Method.MACE_MP_0B2_L.default_engine().value
+        'mace'
+        >>> Method.GFN2_XTB.default_engine().value
+        'xtb'
+        >>> Method.GFN2_XTB.default_engine(is_periodic=True).value
+        'tblite'
         """
         match self:
             case Method.AIMNET2_WB97MD3:
-                return "aimnet2"
+                return Engine.AIMNET2
             case Method.MACE_MP_0B2_L:
-                return "mace"
+                return Engine.MACE
             case Method.OCP24_S | Method.OCP24_L:
-                return "ocp24"
+                return Engine.OCP24
             case Method.OMOL25_CONSERVING_S | Method.UMA_M_OMOL | Method.UMA_S_OMOL:
-                return "omol25"
+                return Engine.OMOL25
             case Method.ORB_V3_CONSERVATIVE_INF_OMAT:
-                return "orb"
-            case _ if self in XTB_METHODS:
-                return "tblite" if is_periodic else "xtb"
+                return Engine.ORB
+            case method if method in XTB_METHODS:
+                return Engine.TBLITE if is_periodic else Engine.XTB
             case Method.OFF_SAGE_2_2_1:
-                return "openff"
+                return Engine.OPENFF
             case Method.EGRET_1 | Method.EGRET_1E | Method.EGRET_1T:
-                return "egret"
+                return Engine.EGRET
             case _:
                 # All remaining methods (HF, DFT, composite, etc.) fall back to Psi4
-                return "psi4"
+                return Engine.PSI4
 
 
 PrepackagedNNPMethod = Literal[

stjames-0.0.99/stjames/optimization/freezing_string_method.py

@@ -0,0 +1,56 @@
+"""Settings for the Freezing String Method (FSM)."""
+
+from typing import Annotated, Self
+
+from pydantic import AfterValidator, BaseModel, PositiveFloat, PositiveInt, model_validator
+
+from ..base import LowercaseStrEnum, round_float
+
+
+class FSMOptimizationCoordinates(LowercaseStrEnum):
+    """Coordinate systems for FSM optimization step."""
+
+    CARTESIAN = "cartesian"
+    REDUNDANT_INTERNAL_COORDINATES = "redundant_internal_coordinates"
+
+
+class FSMInterpolation(LowercaseStrEnum):
+    """Methods for FSM interpolation step."""
+
+    CARTESIAN = "cartesian"
+    LINEAR_SYNCHRONOUS_TRANSIT = "linear_synchronous_transit"
+    REDUNDANT_INTERNAL_COORDINATES = "redundant_internal_coordinates"
+
+
+class FSMSettings(BaseModel):
+    """
+    Settings for the Freezing String Method (FSM) TS search.
+
+    :param opt_coords: coordinate system to use for optimization
+    :param interpolation_method: method to use for interpolation between nodes
+    :param min_num_nodes: minimum number of nodes to use in the string
+    :param num_interpolation_points: number of interpolation points to use between end nodes
+    :param max_optimizer_iterations: maximum number of optimizer iterations to perform  (scipy.minimize maxiter)
+    :param max_line_search_steps: maximum number of line search steps to perform (scipy.minimize maxls)
+    :param max_displacement: maximum displacement for a single coordinate (Å for distances, internally converted for angles)
+    """
+
+    optimization_coordinates: FSMOptimizationCoordinates = FSMOptimizationCoordinates.CARTESIAN
+    interpolation_method: FSMInterpolation = FSMInterpolation.REDUNDANT_INTERNAL_COORDINATES
+
+    min_num_nodes: PositiveInt = 18
+    num_interpolation_points: PositiveInt = 100
+
+    max_optimizer_iterations: PositiveInt = 3
+    max_line_search_steps: PositiveInt = 2
+    max_displacement: Annotated[PositiveFloat, AfterValidator(round_float(3))] = 0.3
+
+    @model_validator(mode="after")
+    def sanity_check(self) -> Self:
+        """Sanity check for settings."""
+        if self.min_num_nodes < 5:
+            raise ValueError("Must have at least 5 nodes for the Freezing String Method.")
+        if self.max_displacement < 0.001:
+            raise ValueError("Maximum displacement must be at least 0.001 Å.")
+
+        return self

{stjames-0.0.98 → stjames-0.0.99}/stjames/workflows/docking.py

@@ -58,11 +58,10 @@ class DockingWorkflow(MoleculeWorkflow):
     :param mode: Mode for workflow (currently unused)
 
     New:
-    :param docking_engine: which docking method to use
     :param do_csearch: whether to csearch starting structures
-    :param csearch_settings: settings for initial conformer search.
+    :param conformer_gen_settings: settings for initial conformer search.
     :param do_optimization: whether to optimize starting structures
-    :param opt_settings: settings for conformer optimization.
+    :param optimization_settings: settings for conformer optimization.
     :param do_pose_refinement: whether to optimize non-rotatable bonds in output poses
     :param target: PDB of the protein.
     :param target_uuid: UUID of the protein.

stjames-0.0.99/stjames/workflows/double_ended_ts_search.py

@@ -0,0 +1,77 @@
+"""Double ended transition-state-search workflow."""
+
+from typing import Annotated, Self
+
+from pydantic import AfterValidator, PositiveFloat, model_validator
+
+from ..molecule import Molecule
+from ..optimization.freezing_string_method import FSMSettings
+from ..settings import Settings
+from ..types import UUID, round_list
+from .workflow import Workflow
+
+
+class DoubleEndedTSSearchWorkflow(Workflow):
+    """
+    Settings for running a double-ended-transition-state-search Workflow.
+
+    # Inputs
+    :param reactant: reactant Molecule
+    :param product: product Molecule
+    :param calculation_settings: Settings for the calculations
+    :param search_settings: Settings for the search
+    :param optimize_inputs: Whether to optimize the input reactant and product
+    :param optimize_ts: Whether to optimize the guess transition state
+
+    # Results
+    :param forward_string_distances: distances along the string
+    :param backward_string_distances: distances along the backward string (starting from the end of the forward string)
+    :param forward_calculation_uuids: UUIDs of the calculations for the forward string nodes
+    :param backward_calculation_uuids: UUIDs of the calculations for the backward string nodes
+    :param ts_guess_calculation_uuid: UUID of the calculation for the guess (or optimized) transition state
+    """
+
+    reactant: Molecule
+    product: Molecule
+
+    calculation_settings: Settings
+    search_settings: FSMSettings
+    optimize_inputs: bool = False
+    optimize_ts: bool = True
+
+    # Results
+    forward_string_distances: Annotated[list[PositiveFloat], AfterValidator(round_list(5))] = []
+    backward_string_distances: Annotated[list[PositiveFloat], AfterValidator(round_list(5))] = []
+
+    forward_calculation_uuids: list[UUID | None] = []
+    backward_calculation_uuids: list[UUID | None] = []
+
+    ts_guess_calculation_uuid: UUID | None = None
+
+    @model_validator(mode="after")
+    def validate_input_molecules(self) -> Self:
+        """Validate that reactant and product are compatible."""
+
+        if self.reactant.charge != self.product.charge:
+            raise ValueError("Reactant and product must have the same charge.")
+        if self.reactant.multiplicity != self.product.multiplicity:
+            raise ValueError("Reactant and product must have the same multiplicity.")
+
+        if len(self.reactant) != len(self.product):
+            raise ValueError("Reactant and product must have the same number of atoms.")
+
+        for r_atom, p_atom in zip(self.reactant.atoms, self.product.atoms, strict=True):
+            if r_atom.atomic_number != p_atom.atomic_number:
+                raise ValueError("Reactant and product must have the same atom ordering.")
+
+        return self
+
+    @property
+    def path_uuids(self) -> list[UUID | None]:
+        """Return the path from reactant to product."""
+        return self.forward_calculation_uuids + self.backward_calculation_uuids
+
+    @property
+    def distances(self) -> list[float]:
+        """Return the path from reactant to product."""
+        return self.forward_string_distances + self.backward_string_distances[::-1]

{stjames-0.0.98 → stjames-0.0.99}/stjames/workflows/fukui.py

@@ -1,10 +1,13 @@
 """Fukui index workflow."""
 
-from typing import Annotated
+from typing import Annotated, Self
 
-from pydantic import AfterValidator
+from pydantic import AfterValidator, model_validator
+
+from stjames.method import Method
 
 from ..base import round_optional_float
+from ..engine import Engine
 from ..settings import Settings
 from ..types import UUID, FloatPerAtom, round_optional_float_per_atom
 from .workflow import MoleculeWorkflow
@@ -20,9 +23,9 @@ class FukuiIndexWorkflow(MoleculeWorkflow):
 
     Settings:
     :param opt_settings: if given, the settings for optimization. if none, no optimization will be conducted.
-    :param opt_engine: the engine for optimization
+    :param opt_engine: the engine for optimization [uses opt_settings.method.default_engine if not set]
     :param fukui_settings: the settings for Fukui index calculations.
-    :param fukui_engine: the engine for Fukui index calculations
+    :param fukui_engine: the engine for Fukui index calculations [uses fukui_settings.method.default_engine if not set]
 
     Results:
     :param optimization: UUID of optimization
@@ -33,10 +36,10 @@ class FukuiIndexWorkflow(MoleculeWorkflow):
     """
 
     opt_settings: Settings | None = None
-    opt_engine: str | None = None
+    opt_engine: Engine | None = None
 
-    fukui_settings: Settings = Settings(method="gfn1_xtb")
-    fukui_engine: str | None = None
+    fukui_settings: Settings = Settings(method=Method.GFN1_XTB)
+    fukui_engine: Engine = None  # type: ignore [assignment]
 
     optimization: UUID | None = None
 
@@ -44,3 +47,12 @@ class FukuiIndexWorkflow(MoleculeWorkflow):
     fukui_positive: Annotated[FloatPerAtom | None, AfterValidator(round_optional_float_per_atom(6))] = None
     fukui_negative: Annotated[FloatPerAtom | None, AfterValidator(round_optional_float_per_atom(6))] = None
     fukui_zero: Annotated[FloatPerAtom | None, AfterValidator(round_optional_float_per_atom(6))] = None
+
+    @model_validator(mode="after")
+    def set_engines(self) -> Self:
+        """Set the engines for optimization and Fukui index calculations."""
+        if self.opt_settings is not None and self.opt_engine is None:
+            self.opt_engine = self.opt_settings.method.default_engine()
+        self.fukui_engine = self.fukui_engine or self.fukui_settings.method.default_engine()
+
+        return self

{stjames-0.0.98 → stjames-0.0.99}/stjames/workflows/molecular_dynamics.py

@@ -6,6 +6,7 @@ from pydantic import PositiveFloat, PositiveInt, computed_field, model_validator
 
 from ..base import Base, LowercaseStrEnum
 from ..constraint import PairwiseHarmonicConstraint, SphericalHarmonicConstraint
+from ..engine import Engine
 from ..settings import Settings
 from ..types import UUID
 from .workflow import MoleculeWorkflow
@@ -87,7 +88,7 @@ class MolecularDynamicsWorkflow(MoleculeWorkflow):
     New:
     :param settings: settings for the molecular dynamics simulation
     :param calc_settings: settings for the gradient calculation
-    :param calc_engine: engine to use for the gradient calculation
+    :param calc_engine: engine to use for the gradient calculation [uses calc_settings.method.default_engine() if not set]
 
     Results:
     :param frames: Frames from the MD
@@ -95,6 +96,13 @@ class MolecularDynamicsWorkflow(MoleculeWorkflow):
 
     settings: MolecularDynamicsSettings
     calc_settings: Settings
-    calc_engine: str | None = None
+    calc_engine: Engine = None  # type: ignore[assignment]
 
     frames: list[Frame] = []
+
+    @model_validator(mode="after")
+    def validate_calc_engine(self) -> Self:
+        """Ensure that the calc_engine is set."""
+        self.calc_engine = self.calc_engine or self.calc_settings.method.default_engine()
+
+        return self

{stjames-0.0.98 → stjames-0.0.99/stjames.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stjames
-Version: 0.0.98
+Version: 0.0.99
 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.98 → stjames-0.0.99}/stjames.egg-info/SOURCES.txt

@@ -43,6 +43,8 @@ stjames/data/isotopes.json
 stjames/data/nist_isotopes.json
 stjames/data/read_nist_isotopes.py
 stjames/data/symbol_element.json
+stjames/optimization/__init__.py
+stjames/optimization/freezing_string_method.py
 stjames/workflows/__init__.py
 stjames/workflows/admet.py
 stjames/workflows/basic_calculation.py
@@ -51,6 +53,7 @@ stjames/workflows/conformer.py
 stjames/workflows/conformer_search.py
 stjames/workflows/descriptors.py
 stjames/workflows/docking.py
+stjames/workflows/double_ended_ts_search.py
 stjames/workflows/electronic_properties.py
 stjames/workflows/fukui.py
 stjames/workflows/hydrogen_bond_basicity.py