Package schrodinger :: Package application :: Package mcpro :: Module modelsystemwizard :: Class ModelSystem
[hide private]
[frames] | no frames]

Class ModelSystem


This is where all information regarding the model system are stored.
A few things to note:
   1. All CTs in an object of this class have corresponding entries in the project table.
   2. All structures are wrapped in an object of a `CtObj' class -- see below.
   3. PT stands for project table.

Here are the attributes:
   task_mode       = task_mode     # - Should be initialized to be one of the values: 0 = Mini; 1 = FEP; 2 = DDG; 3 = LRM.
   basename        = None          # - Will point to a `StringVar' object from `_SysSpec'.
   
   # Toggles:
   sys_type        = None          # - Valid values: COMPLEX, LIG_ONLY, PROT_ONLY, and ZMATRIX
                                   # - Will point to an `IntVar' object that stores and controls the system type toggle on
                                   #   `_SysSpec'. See `_SysSpec's `initialize' method.
   has_movie       = False         # - Will be `True' if we have the ligand-perturbation movie.
   use_charge      = None          # - Will point to an `IntVar' object from `_Import', indicating whether we use the
                                   #   charges from the structure file (1) or not (0).
   use_prot_zmat   = None          # - Will point to an `IntVar' object from `_Import', indicating whether we use an
                                   #   existing zmatrix for the protien (1) or not (0).
   use_reflig      = None          # - Will point to an `IntVar' object from `_Import', indicating whether we use a
                                   #   reference ligand (1) or not (0).
   is_flex_lig     = None          # - Will point to an `IntVar' object from `Flex', indicating whether the ligand is
                                   #   fully flexible (1) or not (0).
   is_flex_cof     = None          # - Will point to an `IntVar' object from `Flex', indicating whether the cofactor is
                                   #   fully flexible (1) or not (0).
   is_cartesian    = 0             # - 0 = cartesian; 1 = internal coordinate minimization
   is_prepared     = False         # - True if the final system was created on Maestro, false otherwise.
   prot_constr     = None          # - Will point to a `StringVar' object from `Flex', indicating whether the protein is
                                   #   fully flexible ('0') or fully rigid ('1') or partially rigid ('2').

   # Structures (`CtObj' objects):
   lig             = [None, None, None,]
                                   # - Ligand structures: lig[0] = reference, lig[1] = original, lig[2] = perturbed
   prot            = None          # - Raw/untreated protein
   chop            = None          # - Chopped protein
   neut            = None          # - Neutralized protein
   prot_final      = None          # - Final protein
   lig_final       = None          # - Final ligand
   prot_zmat_fname = None          # - Name of the existing protein zmatrix file
   sys_zmat        = None          # - Existing zmatrix structure
   movie_ct        = None          # - A series of structures simulating the perturbation from `lig[1]' to `lig[2]'
   
   # Misc.
   ffield          = None          # - Will point to a `StringVar' object from `Flex', storing the force field type.
   r_chop          = None          # - Will point to a `StringVar' object from `ChopCap', storing the chop radius.
   r_flex          = None          # - Will point to a `StringVar' object from `Flex', storing the flexible-region radius.
   neut_target     = None          # - Will point to an `EntryField object from `Neut', storing the target charge.
   neut_to_target  = None          # - Will point to a `StringVar' object from `Neut', indicating if alternative target charge is to be used
   gen_success     = None          # - Will be a function to send out signal saying the final model system is ready.
   rtr_success     = None          # - Will be a function to send out signal saying the final model system is not ready.
   tol_bond        = None          # - Will point to a `EntryField' object from `Flex', storing the bond tolernace.
   tol_angle       = None          # - Will point to a `EntryField' object from `Flex', storing the angle tolernace.
   tol_dih         = None          # - Will point to a `EntryField' object from `Flex', storing the dihedral tolernace.

Nested Classes [hide private]
  CtObj
This class is created to group together all relevant data about a structure and to provide functions for displaying the structure on Maestro workspace easily.
Instance Methods [hide private]
 
__init__(self, task_mode, display)
This initializes the class property `_display' to be `display' argument, `task_mode' attribute to `task_mode' argument, and all other attributes to their own default values.
 
reset(self)
Resets the following attributes to their default values.
 
get_basename(self)
Returns the basename with leading and trailing spaces trimmed.
 
get_prot(self)
Returns the current active protein or `None' if there is none.
 
get_lig_heavy_atom_num(self)
Returns number of heavy atoms in ligand CT.
 
get_solvent_cap_coordinates(self)
Returns the xyz coordinates that correspond to the location of the solvent cap.
 
gen_mcpro_command(self, task)
Returns a tuple of the command to be run (as a list) and the log filename.
Class Variables [hide private]
  _ENTRY_PREFIX = "_mcpro_"
  _display = None
hash(x)
  LIG0_NAME = "lig0"
  LIG1_NAME = "lig1"
  LIG2_NAME = "lig2"
  PROT_NAME = "prot"
  CHOP_NAME = "chop"
  NEUT_NAME = "neut"
  PERT_NAME = "pert_sim"
  ZMAT_NAME = "zmat"
  PROT_FINAL_NAME = "prot_final"
  LIG_FINAL_NAME = "lig_final"
  COMPLEX = 0
  LIG_ONLY = 1
  PROT_ONLY = 2
  ZMATRIX = 3
  ENABLED_SYS_TYPE = [[1, 1, 1, 0,], [1, 1, 0, 0,], [1, 0, 0, 0,...
  DEFAULT_BASENAME = "mcpro_model_sys"
Method Details [hide private]

get_basename(self)

 

Returns the basename with leading and trailing spaces trimmed. The returned basename will be obtained from `_SysSpec' if the string overthere is valid, otherwise default basename will be used.

get_solvent_cap_coordinates(self)

 

Returns the xyz coordinates that correspond to the location of the solvent cap. Use reference ligand coordinates if available and first ligand coords if not


Class Variable Details [hide private]

ENABLED_SYS_TYPE

Value:
[[1, 1, 1, 0,], [1, 1, 0, 0,], [1, 0, 0, 0,], [1, 0, 0, 0,],]