stjames 0.0.122__tar.gz → 0.0.123__tar.gz

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

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

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

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

@@ -41,11 +41,24 @@ 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 (optionally) clustering conformers based on three-dimensional properties.
+    Settings for clustering conformers based on their three-dimensional properties.
 
-    The properties used for clustering are:
+    The properties used for clustering by default are:
     - Solvent-accessible surface area
     - Polar solvent-accessible surface area
     - Radius of gyration
@@ -59,6 +72,15 @@ class ConformerClusteringSettings(Base):
     :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
 
@@ -324,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

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/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.122 → 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.122 → 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):
     """
@@ -99,10 +103,10 @@ class ProteinSequenceWorkflow(Workflow):
     """
     Base class for Workflows that operate on protein sequences.
 
-    :param initial_protein_sequences: protein sequences of interest
+    :param initial_protein_sequences: protein sequences to evaluate, either plain sequence strings or ProteinSequence objects with metadata
     """
 
-    protein_sequences: list[str]
+    initial_protein_sequences: list[ProteinSequence] | list[str] = []
 
 
 class DBCalculation(Base):

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stjames
-Version: 0.0.122
+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.122 → 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
@@ -67,9 +68,11 @@ 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