stjames 0.0.121__tar.gz → 0.0.123__tar.gz

{stjames-0.0.121/stjames.egg-info → stjames-0.0.123}/PKG-INFO

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

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

{stjames-0.0.121 → stjames-0.0.123}/stjames/workflows/__init__.py

@@ -18,6 +18,7 @@ from .ion_mobility import *
 from .irc import *
 from .macropka import *
 from .molecular_dynamics import *
+from .msa import *
 from .multistage_opt import *
 from .nmr import *
 from .pka import *
@@ -49,6 +50,7 @@ WORKFLOW_NAME = Literal[
     "irc",
     "macropka",
     "molecular_dynamics",
+    "msa",
     "multistage_opt",
     "nmr",
     "pka",
@@ -81,6 +83,7 @@ WORKFLOW_MAPPING: dict[WORKFLOW_NAME, Workflow] = {
     "macropka": MacropKaWorkflow,  # type: ignore [dict-item]
     "molecular_dynamics": MolecularDynamicsWorkflow,  # type: ignore [dict-item]
     "multistage_opt": MultiStageOptWorkflow,  # type: ignore [dict-item]
+    "msa": MSAWorkflow,  # type: ignore [dict-item]
     "nmr": NMRSpectroscopyWorkflow,  # type: ignore [dict-item]
     "pka": pKaWorkflow,  # type: ignore [dict-item]
     "pose_analysis_md": PoseAnalysisMolecularDynamicsWorkflow,  # type: ignore [dict-item]

{stjames-0.0.121 → stjames-0.0.123}/stjames/workflows/conformer_search.py

@@ -3,9 +3,9 @@
 from abc import ABC
 from typing import Annotated, Literal, Self, Sequence, TypeVar
 
-from pydantic import AfterValidator, BaseModel, Field, field_validator, model_validator
+from pydantic import AfterValidator, BaseModel, Field, PositiveInt, field_validator, model_validator
 
-from ..base import LowercaseStrEnum
+from ..base import Base, LowercaseStrEnum
 from ..constraint import Constraint
 from ..method import Method, XTBMethod
 from ..mode import Mode
@@ -41,6 +41,50 @@ class ScreeningSettings(BaseModel):
     max_confs: int | None = None
 
 
+class ConformerClusteringDescriptor(LowercaseStrEnum):
+    """
+    Potential descriptors to employ in conformer clustering.
+    """
+
+    SOLVENT_ACCESSIBLE_SURFACE_AREA = "solvent_accessible_surface_area"
+    POLAR_SOLVENT_ACCESSIBLE_SURACE_AREA = "polar_solvent_accessible_surface_area"
+    RADIUS_OF_GYRATION = "radius_of_gyration"
+    PLANE_OF_BEST_FIT = "plane_of_best_fit"
+    NORMALIZED_PRINCIPAL_MOMENT_RATIO_1 = "normalized_principal_moment_ratio_1"
+    NORMALIZED_PRINCIPAL_MOMENT_RATIO_2 = "normalized_principal_moment_ratio_2"
+
+
+class ConformerClusteringSettings(Base):
+    """
+    Settings for clustering conformers based on their three-dimensional properties.
+
+    The properties used for clustering by default are:
+    - Solvent-accessible surface area
+    - Polar solvent-accessible surface area
+    - Radius of gyration
+    - Plane of best fit
+    - Normalized principal moment ratios 1 and 2
+
+    Rowan uses k-means clustering to identify representative conformers.
+    This loosely follows Wilcken and co-workers (10.1007/s10822-020-00337-7).
+
+    :param num_clusters: the number of clusters to include
+    :param conformers_per_cluster: the number of compounds to pick from each cluster
+    """
+
+    descriptors: list[ConformerClusteringDescriptor] = [
+        ConformerClusteringDescriptor.SOLVENT_ACCESSIBLE_SURFACE_AREA,
+        ConformerClusteringDescriptor.POLAR_SOLVENT_ACCESSIBLE_SURACE_AREA,
+        ConformerClusteringDescriptor.RADIUS_OF_GYRATION,
+        ConformerClusteringDescriptor.PLANE_OF_BEST_FIT,
+        ConformerClusteringDescriptor.NORMALIZED_PRINCIPAL_MOMENT_RATIO_1,
+        ConformerClusteringDescriptor.NORMALIZED_PRINCIPAL_MOMENT_RATIO_2,
+    ]
+
+    num_clusters: PositiveInt = 5
+    conformers_per_cluster: PositiveInt = 3
+
+
 class ConformerGenSettings(BaseModel):
     """
     Conformer generation settings.
@@ -302,6 +346,7 @@ class ConformerGenMixin(BaseModel):
     :param constraints: constraints to add
     :param nci: add a constraining potential for non-covalent interactions
     :param max_confs: maximum number of conformers to keep
+    :param clustering_settings: how to cluster the conformers (if at all)
     """
 
     conf_gen_mode: Mode = Mode.RAPID
@@ -310,6 +355,8 @@ class ConformerGenMixin(BaseModel):
     nci: bool = False
     max_confs: int | None = None
 
+    conformer_clustering_settings: ConformerClusteringSettings | None = None
+
     @model_validator(mode="after")
     def validate_and_build_conf_gen_settings(self) -> Self:
         """Validate and build the ConformerGenSettings."""

stjames-0.0.123/stjames/workflows/dna.py

@@ -0,0 +1,13 @@
+"""DNA-related workflow data models."""
+
+from ..base import Base
+
+
+class DNASequence(Base):
+    """
+    DNA sequence metadata.
+
+    :param sequence: nucleotide string
+    """
+
+    sequence: str

stjames-0.0.123/stjames/workflows/msa.py

@@ -0,0 +1,31 @@
+from ..base import LowercaseStrEnum
+from .workflow import ProteinSequenceWorkflow
+
+
+class MSAFormat(LowercaseStrEnum):
+    """Format of the MSA."""
+
+    COLABFOLD_DEFAULT = "colabfold_default"
+    AF3_JSON = "af3_json"
+
+
+class MSAWorkflow(ProteinSequenceWorkflow):
+    """
+    Workflow for generating a MSA from protein sequences.
+
+    Inherited:
+    :param initial_protein_sequences: protein sequences of interest
+
+    New:
+    :param format: the format of the MSA return files
+
+    Results:
+    :param a3m_file: A3M file string
+    :param m8_file: M8 file string
+    :param af3_json_file: AF3 JSON file string
+    """
+
+    format: MSAFormat = MSAFormat.COLABFOLD_DEFAULT
+    a3m_file: str | None = None
+    m8_file: str | None = None
+    af3_json_file: str | None = None

stjames-0.0.123/stjames/workflows/protein.py

@@ -0,0 +1,15 @@
+"""Protein-related workflow data models."""
+
+from ..base import Base
+
+
+class ProteinSequence(Base):
+    """
+    Protein sequence metadata including cyclic flag.
+
+    :param sequence: amino-acid sequence string
+    :param cyclic: whether this sequence forms a cyclic peptide (defaults to False)
+    """
+
+    sequence: str
+    cyclic: bool = False

{stjames-0.0.121 → stjames-0.0.123}/stjames/workflows/protein_cofolding.py

@@ -68,10 +68,14 @@ class AffinityScore(BaseModel):
 
 class ProteinCofoldingWorkflow(FASTAWorkflow):
     """
-    A workflow for predicting structures. Especially protein structures.
+    Workflow for predicting structures.
+
+    Especially protein structures. At least one biological sequence is required.
 
     Inherited:
     :param initial_protein_sequences: protein sequences of interest
+    :param initial_dna_sequences: DNA sequences of interest
+    :param initial_rna_sequences: RNA sequences of interest
     :param initial_smiles_list: SMILES strings of interest
 
     New:

stjames-0.0.123/stjames/workflows/rna.py

@@ -0,0 +1,13 @@
+"""RNA-related workflow data models."""
+
+from ..base import Base
+
+
+class RNASequence(Base):
+    """
+    RNA sequence metadata.
+
+    :param sequence: nucleotide string
+    """
+
+    sequence: str

{stjames-0.0.121 → stjames-0.0.123}/stjames/workflows/workflow.py

@@ -1,5 +1,7 @@
 """Base classes for workflows."""
 
+from typing import Any
+
 from pydantic import field_validator
 
 from ..base import Base
@@ -7,6 +9,9 @@ from ..message import Message
 from ..mode import Mode
 from ..molecule import Molecule
 from ..types import UUID
+from .dna import DNASequence
+from .protein import ProteinSequence
+from .rna import RNASequence
 
 
 class Workflow(Base):
@@ -22,31 +27,30 @@ class Workflow(Base):
         return repr(self)
 
 
-class ProteinSequence(Base):
-    """
-    Protein sequence metadata including cyclic flag.
-
-    :param sequence: amino-acid sequence string
-    :param cyclic: whether this sequence forms a cyclic peptide (defaults to False)
-    """
-
-    sequence: str
-    cyclic: bool = False
-
-
 class FASTAWorkflow(Workflow):
     """
-    Base class for Workflows that operate on protein sequences and SMILES.
+    Base class for Workflows that operate on biological sequences and SMILES.
 
-    :param initial_protein_sequences: proteins to evaluate, either plain sequence strings or ProteinSequence objects with cyclic flags
+    :param initial_protein_sequences: protein sequences to evaluate, either plain sequence strings or ProteinSequence objects with metadata
+    :param initial_dna_sequences: DNA sequences to evaluate, either plain sequence strings or DNASequence objects with metadata
+    :param initial_rna_sequences: RNA sequences to evaluate, either plain sequence strings or RNASequence objects with metadata
     :param initial_smiles_list: SMILES strings of interest
     :param ligand_binding_affinity_index: optional index selecting which ligand affinity to evaluate
+    :raises ValueError: if none of the sequence lists are provided
     """
 
-    initial_protein_sequences: list[ProteinSequence] | list[str]
-    initial_smiles_list: list[str] | None = None
+    initial_protein_sequences: list[ProteinSequence] | list[str] = []
+    initial_dna_sequences: list[DNASequence] = []
+    initial_rna_sequences: list[RNASequence] = []
+    initial_smiles_list: list[str] = []
     ligand_binding_affinity_index: int | None = None
 
+    def model_post_init(self, __context: Any) -> None:
+        if not (self.initial_protein_sequences or self.initial_dna_sequences or self.initial_rna_sequences):
+            raise ValueError(
+                "Provide at least one of `initial_protein_sequences`, `initial_dna_sequences`, or `initial_rna_sequences`.",
+            )
+
 
 class SMILESWorkflow(Workflow):
     """
@@ -95,6 +99,16 @@ class MoleculeWorkflow(Workflow):
         return mode
 
 
+class ProteinSequenceWorkflow(Workflow):
+    """
+    Base class for Workflows that operate on protein sequences.
+
+    :param initial_protein_sequences: protein sequences to evaluate, either plain sequence strings or ProteinSequence objects with metadata
+    """
+
+    initial_protein_sequences: list[ProteinSequence] | list[str] = []
+
+
 class DBCalculation(Base):
     """Encodes a calculation that's in the database. This isn't terribly useful by itself."""
 

{stjames-0.0.121 → stjames-0.0.123/stjames.egg-info}/PKG-INFO

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

@@ -53,6 +53,7 @@ stjames/workflows/bde.py
 stjames/workflows/conformer.py
 stjames/workflows/conformer_search.py
 stjames/workflows/descriptors.py
+stjames/workflows/dna.py
 stjames/workflows/docking.py
 stjames/workflows/double_ended_ts_search.py
 stjames/workflows/electronic_properties.py
@@ -62,13 +63,16 @@ stjames/workflows/ion_mobility.py
 stjames/workflows/irc.py
 stjames/workflows/macropka.py
 stjames/workflows/molecular_dynamics.py
+stjames/workflows/msa.py
 stjames/workflows/multistage_opt.py
 stjames/workflows/nmr.py
 stjames/workflows/pka.py
 stjames/workflows/pose_analysis_md.py
+stjames/workflows/protein.py
 stjames/workflows/protein_binder_design.py
 stjames/workflows/protein_cofolding.py
 stjames/workflows/redox_potential.py
+stjames/workflows/rna.py
 stjames/workflows/scan.py
 stjames/workflows/solubility.py
 stjames/workflows/spin_states.py