Package Biskit :: Module Prosa2003 :: Class Prosa2003
[hide private]
[frames] | no frames]

Class Prosa2003

source code


Analyze energies using Prosa2003 for a given PDBModels.

Reference

Example usage

>>> x = Prosa2003( ref_model, [ m1, m2 ], verbose=1 )
>>> result = x.run()

Settings

Structure of the input file

:
  pair potential --- read in other than default potential
  surface potential
  pdb_dir --- directory with pdb file
  read pdb |filename| |object name|
  lower_k |int|
  upper_k |int|
  pot_lb |float|
  pot_ub |float|
  analyse energy |object name| 
  print energy |object name| |filename(.ana)|
  exit --- exit without launching graphical mode


Instance Methods [hide private]
  __init__(self, models, **kw)
float execute(self, inp=None)
Run Prosa2003.
  checkPotentials(self)
Check that the environment variable $PROSA_BASE is correct and that the potential files are there.
  prepare(self)
Make and write a PROSA compatible pdb file.
  cleanup(self)
dict parse_result(self)
Parse the Prosa2003 output file.
[float] prosaEnergy(self)
Sum of energy profiles.
  isFailed(self)
  finish(self)

Class Variables [hide private]
  inp = """pair potential $PROSA_BASE/%(pairPot)s pcb surfac...

Method Details [hide private]

__init__(self, models, **kw)
(Constructor)

source code 
Parameters:
  • models (PDBModels) - if more than one model is given they are concatenated and the energy is calculated for the two together.
  • kw (key=value pairs :
     debug    - 0|1, keep all temporary files (default: 0)
     verbose  - 0|1, print progress messages to log (log != STDOUT)
     node     - str, host for calculation (None->local) NOT TESTED
                     (default: None)
     nice     - int, nice level (default: 0)
     log      - Biskit.LogFile, program log (None->STOUT) (default: None)
    
    ) - additional key=value parameters for Executor:

execute(self, inp=None)

source code 

Run Prosa2003.
Returns: float
duration of calculation in seconds
Raises:

Note: Was forced to overwrite execute function of Executor to get prosa2003 running (the code below equals an os.system call).

checkPotentials(self)

source code 

Check that the environment variable $PROSA_BASE is correct and that the potential files are there.

prepare(self)

source code 

Make and write a PROSA compatible pdb file.
  • consecutive residue numbering
  • same chainId troughout the model

Note: Overrides Executor method.

cleanup(self)

source code 

parse_result(self)

source code 

Parse the Prosa2003 output file.
Returns: dict
dictionary with the calculated potential profiles and the parameters used

prosaEnergy(self)

source code 

Sum of energy profiles.
Returns: [float]
sum of the three energy profiles [ E_prosa_pair, E_prosa_surf, E_prosa_tot]

isFailed(self)

source code 

Note: Overrides Executor method

finish(self)

source code 

Note: Overrides Executor method


Class Variable Details [hide private]

inp

Value:
"""pair potential $PROSA_BASE/%(pairPot)s pcb
surface potential $PROSA_BASE/%(surfPot)s scb
pdb_dir = %(temp_dir)s
read pdb %(prosaPdbFile)s %(objectName)s 
lower_k = %(lower_k)i 
upper_k = %(upper_k)i 
pot_lb = %(pot_lb)3.1f 
pot_ub = %(pot_ub)3.1f 
...