Package schrodinger :: Package application :: Package macromodel :: Module utils :: Class ComUtil
[hide private]
[frames] | no frames]

Class ComUtil

A class for writing MacroModel com files.

The class has methods to write jobname.com files for a broad range of calculation types. The class is initallized with reasonable OPCD argument default values, so the methods like mini() are usable 'out of the box'. The OPCD arguments are easily modified by accessing the dict values. There is a generic writeComFile() method that allows you write any com file by passing a list of arguments, IO and OPCDs.

If no arguments are provide to the constructor the defaults are:

API examples:

   # Example 1 ############################################################
   # Writing an energy listing com file via writeComFile. 
   import schrodinger.application.macromodel.utils as mmodutils
   mcu = mmodutils.ComUtil() # create a default instance of the class
   com_file_args = [
       'example1.com', # The name of the com file to write.
       'input.mae', # The name of the input structure file.
       'output.mae', # The name of the output structure file.
       'EXNB',
       'BDCO',
       'FFLD',
       'READ',
       'ELST'
   ]
   mcu.writeComFile(com_file_args)

   # Example 2 ############################################################
   # Writing an energy listing com file via a utility methods.
   import schrodinger.application.macromodel.utils as mmodutils
   mcu = mmodutils.ComUtil()
   com_file_name = mcu.elst('example2.mae')

   # Example 3 ############################################################
   # Writing an minimization com file with customized parameters.
   import schrodinger.application.macromodel.utils as mmodutils
   mcu = mmodutils.ComUtil()
   mcu.MINI[1] = 9 # Use Truncated Newton Conjugate Gradient minimizer.
   mcu.CONV[5] = 0.0001 # Halt when gradient reaches this stringent value.
   mcu.mini('example3.mae')

   # Example 4 ############################################################
   # Writing an minimization com file that includes water GB/SA solvation.
   import schrodinger.application.macromodel.utils as mmodutils
   mcu = mmodutils.ComUtil(solv=True)
   mcu.mini('example4.mae')

   # Example 5 ############################################################
   # Writing an minimization com file that requests a substructure.
   # See the SbcUtil class for how to construct a .sbc file, this
   # example assumes an appropriate .sbc file already exists.
   import schrodinger.application.macromodel.utils as mmodutils
   mcu = mmodutils.ComUtil(subs=True)
   mcu.mini('example5.mae')
Instance Methods [hide private]
 
__init__(self, ffld="oplsaa2005", solv=False, ddde=False, bdco=True, chgf=False, exnb=True, auto=True, auop=True, subs=False, serial=False, demx=True, demx_final=50, demx_prelim=100, algn=False, nant=False, chyd=True, nprc=False, flap=False, mcrc=False, ddebug=False, nice=False, wait=False, host="", hostfile="", arch="", local=False, interval=5, no_redirect=False, tmpdir="", ver="", rel="", proj="", disp="", user="", para_bmin=False, para_bmin_jobcts=100, para_bmin_njobs=10, para_bmin_output_org="", debug=False, beautify=True, refit_args=True)
This method loads the default data members and methods.
 
writeComFile(self, com_args=[])
This method writes a com file, and returns the name of the written com file.
 
writeSbcFile(self, sbc_args=[])
Deprecated wrapper for SbcUtil.writeSbcFile.
 
getOpcdArgs(self, opcd="")
This method returns a formatted string of OPCD and arguments for the passed OPCD string.
 
setOpcdArgs(self, opcd="", arg1=0, arg2=0, arg3=0, arg4=0, arg5=0.0, arg6=0.0, arg7=0.0, arg8=0.0)
This method returns True after adding the passed values to the desired opcd dictionary.
 
setupAset(self, set_dict, arg7=0, arg8=0)
Define ASET arguments from a set dictionary.
 
getLaunchCommand(self, com_file="")
This method returns a list of arguments that form the toplevel command invocation with all the flags set in the instance.
 
elst(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file for a single point energy listing, returns the name of the com file written.
 
dlst(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file for a single point energy listing of 1st and 2nd derivatives, returns the name of the com file written.
 
mini(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file for a geometry optimization, returns the name of the com file written.
 
addc(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file for redundant conformer elimination, returns the name of the com file written.
 
filter(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file for a special atom filtering, similar to premin's, but with 0 minimization iterations; returns the name of the com file written.
 
mult(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file for a geometry optimization and filtering with MULT and COMP; returns the name of the com file written.
 
driv(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file for a geometry drive; returns the name of the com file written.
 
lmod(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file for a lowmode conformation search; returns the name of the com file written.
 
llmd(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file for a large scale lowmode conformation search; returns the name of the com file written.
 
mcmm(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file for a monte carlo multiple minimum conformation search; returns the name of the com file written.
 
spmc(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file for a systematic pseudo monte carlo multiple minimum conformation search; returns the name of the com file written.
 
mcmmlmod(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file for a mixed monte carlo multiple minimum/lowmode conformation search; returns the name of the com file written.
 
mcmmllmd(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file for a mixed monte carlo multiple minimum/large scale lowmode conformation search; returns the name of the com file written.
 
cgen(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file for a ligand torsion search with ConfGen; returns the name of the com file written.
 
mdyn(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file for a molecular dynamics simulation; returns the name of the com file written.
 
mcsd(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file for a mixed Monte Carlo/Stochastic Dynamics simulation; returns the name of the com file written.
 
mmc(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file for a Metropolis Monte Carlo ensemble generation; returns the name of the com file written.
 
adf(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file for an All Degrees of Freedom simulation (a Metropolis Monte Carlo with passive Importance sampling) calculation; returns the name of the com file written.
 
jbw(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file for a Jump Between Wells simulation (a Metropolis Monte carlo simulation with active Importance sampling); returns the name of the com file written.
 
jbw_sd(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file for a Jump Between Wells/Stochastic Dynamics simulation (a MCSD simulation with active Importance sampling); returns the name of the com file written.
 
geom(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file for a geometry analysis; returns the name of the com file written.
 
copyalgn(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file for an ALGN/COPY positioning of ligands on a reference ligand; returns the name of the com file written.
 
mbaeMiniEdiff(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file for an MBAE multiple minimization run, in energy difference mode; returns the name of the com file written.
 
mbaeMiniInter(self, mae_file=None, com_file=None, out_file=None, recep_atom=None)
This method writes a com file for an MBAE multiple minimization run, in set interaction mode; returns the name of the com file written.
 
mbaeCsLmod(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file for an MBAE low mode conformation search run, in energy difference mode; returns the name of the com file written.
 
mbaeCsMcmm(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file for an MBAE monte carlo conformation search run, in energy difference mode; returns the name of the com file written.
 
mbaeCsMcmmLmod(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file for an MBAE mixed lowmode monte carlo conformation search run, in energy difference mode; returns the name of the com file written.
 
logP(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file for a multiple minimization with logP calculation; returns the name of the com file written.
 
fep(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file for a Free Energy Perturbation with stochastic dynamics sampling; returns the name of the com file written.
 
loop(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file for a protein LOOP conformation search; returns the name of the com file written.
 
aset(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file for a atom set interaction (ASET) analysis; returns the name of the com file written.
 
minta(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file for a Mode integration MINTA calculation (conformational free energy); returns the name of the com file written.
 
rrho(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file for a Rigid Rotor Harmonic Oscillator calculation (normal mode analysis of thermodyanic quantities); returns the name of the com file written.
 
vibr(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file to visualize vibrational modes with VIBR; returns the name of the com file written.
 
vbr2(self, mae_file=None, com_file=None, out_file=None)
This method writes a com file to visualize vibrational modes with VBR2; returns the name of the com file written.
Static Methods [hide private]
 
outComFile(file_name="", structure_file_ext='.mae')
This is a static helper method for the jobs that write com files.
Instance Variables [hide private]
boolean beautify
If True don't write disabled opcds.
boolean cgo3
If True enable the writing of CGO3 to com files.
boolean cgo4
If True enable the writing of CGO3 to com files.
boolean cgo5
If True enable the writing of CGO5 to com files.
boolean cgo6
If True enable the writing of CGO6 to com files.
boolean mmod
If True enable MMOD and write MacroModel/Maestro interaction-monitor files.
boolean refit_args
If True reformat large float value to fit in the alternate field format (%6.3f - %9.0f).
boolean serial_nonconf_input
If True enable DEBG 55 property management when self.serial is also True.
string structure_file_ext
Default structure file extention for file names automatically determined by outComFile().
Method Details [hide private]

__init__(self, ffld="oplsaa2005", solv=False, ddde=False, bdco=True, chgf=False, exnb=True, auto=True, auop=True, subs=False, serial=False, demx=True, demx_final=50, demx_prelim=100, algn=False, nant=False, chyd=True, nprc=False, flap=False, mcrc=False, ddebug=False, nice=False, wait=False, host="", hostfile="", arch="", local=False, interval=5, no_redirect=False, tmpdir="", ver="", rel="", proj="", disp="", user="", para_bmin=False, para_bmin_jobcts=100, para_bmin_njobs=10, para_bmin_output_org="", debug=False, beautify=True, refit_args=True)
(Constructor)

 

This method loads the default data members and methods.

It sets default OPCD arguments, and com file preferences (e.g. no solvent model, OPLSAA_2005, yes to BDCO).

Parameters:
  • ffld (string) - String identifier for the force field. The FFLD value is assigned by regular expression evaluation of the string.
  • solv (boolean) - If True enable the writing of SOLV to com files. By default solv=False and the opcode is not written, even if it appears in the list of opcodes.
  • ddde (boolean) - If True enable distance-dependent dielectric electrostatic treatment, with a dielectric constant of 4.0.
  • serial (boolean) - If True enable serial processing mode. This sets AUTO arg6=1, and MCOP arg4=1 where appropriate.
  • bdco (boolean) - If True enable the writing of BDCO to com files. By default bdco=True and the opcode is written if it appears in the list of opcodes.
  • subs (boolean) - If True enable the writing of SUBS to com files. By default subs=False and the opcode is not written, even if it appears in the list of opcodes.
  • chgf (boolean) - If True enable the writing of CHGF to com files. By default chgf=False and the opcode is not written, even if it appears in the list of opcodes.
  • exnb (boolean) - If True enable the writing of EXNB to com files. By default exnb=True. If False it is not written, even if it appears in the list of opcodes.
  • auto (boolean) - If True enable the writing of AUTO to com files. By default auto=True. If False it is not written, even if it appears in the list of opcodes.
  • auop (boolean) - If True enable the writing of AUOP to com files. By default auop=True. If False it is not written, even if it appears in the list of opcodes.
  • nant (boolean) - If True enable the writing of NANT to com files. By default nant=False. If False it is not written, even if it appears in the list of opcodes.
  • algn (boolean) - If True enable the writing of COPY/ALGN to MBAE com files generated by the pre-defined methods, e.g. mbaeCsLmod()
  • demx (boolean) - If True enable the writing of DEMX to com files. By default demx=True. If False it is not written, even if it appears in the list of opcodes.
  • demx_final (float) - Energy window for the final DEMX test. Default is 50 kJ/mol
  • demx_prelim (float) - Energy window for the preliminary DEMX test. Default is 100 kJ/mol. By default DEMX arg2 is set to 10000, so the prelimnary test is seldom performed.

writeComFile(self, com_args=[])

 

This method writes a com file, and returns the name of the written com file.

It requires a list containing the name of the com file to be written, the name of the input file, the name of the output file, and a series of OPCDs. The arguments for the OPCDs are looked up in turn, evaluating the next eight elements for the specific OPCD argument dictionary, each time the OPCD is encountered. See setOpcdArgs(), getOpcdArgs(), and __init__() for more information about default arguments.

getOpcdArgs(self, opcd="")

 

This method returns a formatted string of OPCD and arguments for the passed OPCD string.

The arguments come from the hash data members, any unknown or unassigned values default to 0 or 0.0. You may customize the self hash arguments to your heart's content prior to invoking the method to get the exact behavior you want. The 'OPCD' lookup requires the passed argument to be a key for the hash, i.e. uppercase with no whitespace. The array of arg values are numbers, not strings.

This method keeps count of the number of times an OPCD is called and automatically increments the array of args for the passed OPCD. The first call for a given OPCD uses self['OPCD'] arg slices 1-8, the next call for that OPCD uses slices 9-16, the next 17-24, and so on. writeComFile() zeros the count after the com file is serialized.

setOpcdArgs(self, opcd="", arg1=0, arg2=0, arg3=0, arg4=0, arg5=0.0, arg6=0.0, arg7=0.0, arg8=0.0)

 

This method returns True after adding the passed values to the desired opcd dictionary.

The dictionary is selected by the first parameter, which is required. The rest of the parameters are mapped to the next eight argument indices in the dictionary. Unspecified values default to 0 or 0.0.

This method determines the highest existing index (numeric hash key), and then assigns the passed args to the next available slots. You may want to first blank the dictionary with the appropriate call of self['OPCD'].clear().

Assumming the dictionary has has been cleared, the first 'set' of a given OPCD assigns self['OPCD'] arg indices 1-8, the next call for that OPCD defines indices 9-16, the next 17-24, and so on.

outComFile(file_name="", structure_file_ext='.mae')
Static Method

 

This is a static helper method for the jobs that write com files. Returns an 'out' string for the passed 'in' string.

Raises an Exception if the file name can't be determined.

Parameters:
  • file_name (string) - If passed 'jobname.com' string argument, it returns the appropriate 'jobname-out.mae' string. If passed a 'foo.mae' file, it returns an appropriate 'foo.com' file name.
  • structure_file_ext (string) - Output structure file extension. Default is '.mae'.

setupAset(self, set_dict, arg7=0, arg8=0)

 

Define ASET arguments from a set dictionary.

Numeric hash keys index the lists of atom numbers. The numerical key is taken as the set number identifier.

getLaunchCommand(self, com_file="")

 

This method returns a list of arguments that form the toplevel command invocation with all the flags set in the instance.

It takes a string argument that specifies the name of the com file to run, and returns the fully qualified executable and all commandline arguments.

elst(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file for a single point energy listing, returns the name of the com file written.

It requires a string containing the the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file.

dlst(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file for a single point energy listing of 1st and 2nd derivatives, returns the name of the com file written.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file.

mini(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file for a geometry optimization, returns the name of the com file written.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file.

addc(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file for redundant conformer elimination, returns the name of the com file written.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file.

COMP atoms must be set outside of this method.

filter(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file for a special atom filtering, similar to premin's, but with 0 minimization iterations; returns the name of the com file written.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file.

mult(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file for a geometry optimization and filtering with MULT and COMP; returns the name of the com file written.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file. It is intended for filtering conformation search output.

driv(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file for a geometry drive; returns the name of the com file written.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file. It is intended for filtering conformation search output.

DEGB 150 starts the drive from the input geometry, not the endpoint of the previous iteration.

lmod(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file for a lowmode conformation search; returns the name of the com file written.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file.

llmd(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file for a large scale lowmode conformation search; returns the name of the com file written.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file.

mcmm(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file for a monte carlo multiple minimum conformation search; returns the name of the com file written.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file.

spmc(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file for a systematic pseudo monte carlo multiple minimum conformation search; returns the name of the com file written.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file. This method always uses torsional memory and will preoptimize ring closure distances.

mcmmlmod(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file for a mixed monte carlo multiple minimum/lowmode conformation search; returns the name of the com file written.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file.

mcmmllmd(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file for a mixed monte carlo multiple minimum/large scale lowmode conformation search; returns the name of the com file written.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file.

cgen(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file for a ligand torsion search with ConfGen; returns the name of the com file written.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file.

mdyn(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file for a molecular dynamics simulation; returns the name of the com file written.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file.

mcsd(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file for a mixed Monte Carlo/Stochastic Dynamics simulation; returns the name of the com file written.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file.

mmc(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file for a Metropolis Monte Carlo ensemble generation; returns the name of the com file written.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file.

The arguments for ZMAT must be set outside this method. ZMAT makes all the structural changes so the min-max range should allow diverse sampling (5 deg bends, 180 tors).

adf(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file for an All Degrees of Freedom simulation (a Metropolis Monte Carlo with passive Importance sampling) calculation; returns the name of the com file written.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file.

The arguments for ZMAT must be set outside this method. ZMAT makes all the structural changes so the min-max range should allow diverse sampling (5 deg bends, 180 tors).

jbw(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file for a Jump Between Wells simulation (a Metropolis Monte carlo simulation with active Importance sampling); returns the name of the com file written.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file.

The arguments for ZMAT must be set outside this method.

jbw_sd(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file for a Jump Between Wells/Stochastic Dynamics simulation (a MCSD simulation with active Importance sampling); returns the name of the com file written.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file.

The arguments for ZMAT must be set outside this method.

geom(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file for a geometry analysis; returns the name of the com file written.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file.

The arguments for GEOM must be set outside this method.

copyalgn(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file for an ALGN/COPY positioning of ligands on a reference ligand; returns the name of the com file written.

The ligands are positioned on the first ligand (all four ways) with ALGN/COPY.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file.

mbaeMiniEdiff(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file for an MBAE multiple minimization run, in energy difference mode; returns the name of the com file written.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file.

mbaeMiniInter(self, mae_file=None, com_file=None, out_file=None, recep_atom=None)

 

This method writes a com file for an MBAE multiple minimization run, in set interaction mode; returns the name of the com file written. recep_atom is the last atomic index of the receptor structure. If recep_atom is None then the first structure in the mae_file is evaluated.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file.

The ASET arguments are set by snooping the input file for the number of atoms in the receptor.

raises IOError if the receptor atom total can't be determined from the input structure file.

mbaeCsLmod(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file for an MBAE low mode conformation search run, in energy difference mode; returns the name of the com file written.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file.

If ComUtil.algn is true, then a the job will positions the ligands on the reference ligand, with all four alignments.

mbaeCsMcmm(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file for an MBAE monte carlo conformation search run, in energy difference mode; returns the name of the com file written.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file.

If ComUtil.algn is true, then a the job will positions the ligands on the reference ligand, with all four alignments.

mbaeCsMcmmLmod(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file for an MBAE mixed lowmode monte carlo conformation search run, in energy difference mode; returns the name of the com file written.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file.

If ComUtil.algn is true, then a the job will positions the ligands on the reference ligand, with all four alignments.

logP(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file for a multiple minimization with logP calculation; returns the name of the com file written.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file.

fep(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file for a Free Energy Perturbation with stochastic dynamics sampling; returns the name of the com file written.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file.

loop(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file for a protein LOOP conformation search; returns the name of the com file written.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file.

aset(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file for a atom set interaction (ASET) analysis; returns the name of the com file written.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file.

The arguments for ASET must be set outside this method.

Uses a BGIN/END loop to process each input file member, but single structure input files are allowed.

minta(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file for a Mode integration MINTA calculation (conformational free energy); returns the name of the com file written.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file.

rrho(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file for a Rigid Rotor Harmonic Oscillator calculation (normal mode analysis of thermodyanic quantities); returns the name of the com file written.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file.

The structure is minimized prior to RRHO calculation. The optimization can be omitted by setting MINI[3] = 0

vibr(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file to visualize vibrational modes with VIBR; returns the name of the com file written.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file.

The structure is minimized prior to VIBR calculation. The optimization can be omitted by setting MINI[3] = 0

vbr2(self, mae_file=None, com_file=None, out_file=None)

 

This method writes a com file to visualize vibrational modes with VBR2; returns the name of the com file written.

It requires a string containing the name of a maestro format file that will be used as the job input, and returns the string name of the com file. It may also accept an optional string file name that becomes the name of the com file plus the root of the generated -out.mae file.

The structure is minimized prior to VBR2 calculation. The optimization can be omitted by setting MINI[3] = 0


Instance Variable Details [hide private]

beautify

If True don't write disabled opcds. If False, disabled opcds are printed as commented-out lines. Default is True
Type:
boolean

cgo3

If True enable the writing of CGO3 to com files. By default bdco=True and the opcode is written if it appears in the list of opcodes.
Type:
boolean

cgo4

If True enable the writing of CGO3 to com files. By default bdco=True and the opcode is written if it appears in the list of opcodes.
Type:
boolean

cgo5

If True enable the writing of CGO5 to com files. By default bdco=True and the opcode is written if it appears in the list of opcodes.
Type:
boolean

cgo6

If True enable the writing of CGO6 to com files. By default bdco=True and the opcode is written if it appears in the list of opcodes.
Type:
boolean

mmod

If True enable MMOD and write MacroModel/Maestro interaction-monitor files. This is seldom useful in a script context, but is provided to as an option to make com files look more like Maestro generated files. Default is False.
Type:
boolean

refit_args

If True reformat large float value to fit in the alternate field format (%6.3f - %9.0f). If False, values are printed as %5.4f Default is True.
Type:
boolean

structure_file_ext

Default structure file extention for file names automatically determined by outComFile(). Default is '.mae'.
Type:
string