Class Palmer

Class for interfacing with Art Palmer's Modelfree 4.

Instance Methods

create(self, dir=None, force=False, binary='modelfree4', diff_search='none', sims=0, sim_type='pred', trim=0, steps=20, constraints=True, heteronuc_type='15N', atom1='N', atom2='H', spin_id=None)
Function for creating the Modelfree4 input files.

execute(self, dir=None, force=False, binary='modelfree4')
Function for executing Modelfree4.

extract(self, dir=None)
Function for extracting data from the Modelfree4 'mfout' star formatted file.

Inherited from base_class.User_fn_class: __init__

Method Details

create(self, dir=None, force=False, binary='modelfree4', diff_search='none', sims=0, sim_type='pred', trim=0, steps=20, constraints=True, heteronuc_type='15N', atom1='N', atom2='H', spin_id=None)

Function for creating the Modelfree4 input files.

Keyword Arguments
~~~~~~~~~~~~~~~~~

dir:  The directory to place the files.

force:  A flag which if set to True will cause the results file to be overwritten if it
already exists.

binary:  The name of the executable Modelfree program file.

diff_search:  See the Modelfree4 manual for 'diffusion_search'.

sims:  The number of Monte Carlo simulations.

sim_type:  See the Modelfree4 manual.

trim:  See the Modelfree4 manual.

steps:  See the Modelfree4 manual.

constraints:  A flag specifying whether the parameters should be constrained.  The default
is to turn constraints on (constraints=True).

heteronuc_type:  A three letter string describing the heteronucleus type, ie 15N, 13C, etc.

atom1:  The symbol of the X heteronucleus in the pdb file.

atom2:  The symbol of the H nucleus in the pdb file.

spin_id:  The spin identification string.


Description
~~~~~~~~~~~

The following files are created

    'dir/mfin',
    'dir/mfdata',
    'dir/mfpar',
    'dir/mfmodel',
    'dir/run.sh'.

The file 'dir/run.sh' contains the single command,

'modelfree4 -i mfin -d mfdata -p mfpar -m mfmodel -o mfout -e out',

which can be used to execute modelfree4.

If you would like to use a different Modelfree executable file, change the keyword argument
'binary' to the appropriate file name.  If the file is not located within the environment's
path, include the full path infront of the binary file name.

execute(self, dir=None, force=False, binary='modelfree4')

Function for executing Modelfree4.

Keyword Arguments
~~~~~~~~~~~~~~~~~

dir:  The directory to place the files.

force:  A flag which if set to True will cause the results file to be overwritten if it
already exists.

binary:  The name of the executable Modelfree program file.


Description
~~~~~~~~~~~

Modelfree 4 will be executed as

$ modelfree4 -i mfin -d mfdata -p mfpar -m mfmodel -o mfout -e out

If a PDB file is loaded and non-isotropic diffusion is selected, then the file name will be
placed on the command line as '-s pdb_file_name'.


If you would like to use a different Modelfree executable file, change the keyword argument
'binary' to the appropriate file name.  If the file is not located within the environment's
path, include the full path in front of the binary file name.

extract(self, dir=None)

Function for extracting data from the Modelfree4 'mfout' star formatted file.

Keyword Arguments
~~~~~~~~~~~~~~~~~

dir:  The directory where the file 'mfout' is found.