Difference between revisions of "MSL Programs::repackSideChains"

From MSL-Libraries
Jump to navigationJump to search
(Options)
 
(4 intermediate revisions by one other user not shown)
Line 5: Line 5:
  
 
==Options==  
 
==Options==  
  --pdbfile <pdbfile> PDB structure to analyze. Should have PDB format and CHARMM names for all atoms.
+
  --pdbfile <pdbfile> - PDB structure to analyze. Should have PDB format and CHARMM names for all atoms.
--rotlibfile <rotlibfile> RotamerLibrary file in MSL format.
 
--charmmtopfile <charmmTopFile> CHARMM Topology file.
 
--charmmparfile <charmmParFile> CHARMM parameter file.
 
--hbondparfile <hbondParFile> Hydrogen bond parameters file. [Example file in trunk./library/par_hbond_1.txt]
 
  
 
Optional Parameters  
 
Optional Parameters  
  --outputpdbfile <outputpdbfile> Creates a pdb file with the best(lowest energy) structure obtained. Shpuld be specified for most applications.
+
--rotlibfile <rotlibfile> - RotamerLibrary file in MSL format (defaults to $MSL_DIR/library/EBL_11-2011_CHARMM22.txt).
  --logfile <logfile> The output may be written to a text file. (Does not write the structure out)
+
--charmmtopfile <charmmTopFile> - CHARMM Topology file (defaults to $MSL_DIR/toppar/charmm22.top).
  --verbose <true/false> Prints additional information during the optimization process.
+
--charmmparfile <charmmParFile> - CHARMM parameter file (defaults to $MSL_DIR/toppar/charmm22.par).
 +
--hbondparfile <hbondParFile> - Hydrogen bond parameters file (defaults to $MSL_DIR/toppar/scwrl4hb/par_hbond_1.txt).
 +
  --outputpdbfile <outputpdbfile> - Creates a pdb file with the best(lowest energy) structure obtained. Should be specified for most applications.
 +
  --logfile <logfile> - The output may be written to a text file. (Does not write the structure out. Prints the original and recovered values for chi dihedrals )
 +
  --verbose <true/false> - Prints additional information during the optimization process.
  
 
Non bonded interactions - thresholds
 
Non bonded interactions - thresholds
Line 21: Line 21:
 
  --cutnb <nbcutnb> defaults to 11.0
 
  --cutnb <nbcutnb> defaults to 11.0
  
No interactions between atoms that are > cutnb apart are not considered at all.
+
No interactions between atoms that are greater than cutnb Angstroms apart.
All interactions between cutoff and cutnb have zero energy but the interactions are maintained by the CharmmSystemBuilder.
+
All interactions at distances between cutoff and cutnb have zero energy but the interactions are maintained by the CharmmSystemBuilder.
 
All interactions between cuton and cutoff are weighted using a switching function.
 
All interactions between cuton and cutoff are weighted using a switching function.
  
Line 29: Line 29:
 
  --configfile <configfile> All the options may be specified in a file.
 
  --configfile <configfile> All the options may be specified in a file.
  
Algorithm
+
Algorithms
  --rungoldsteinsingles <true/false>  
+
  --rungoldsteinsingles <true/false> Defaults to true. Dead End Elimination using Goldstein Singles.
  --rungoldsteinpairs <true/false>  
+
  --rungoldsteinpairs <true/false> Defaults to false. Dead End Elimination using Goldstein Pairs.
  --runscmf <true/false>  
+
  --runscmf <true/false> Defaults to true. Runs the Self Consistent Mean Field Algorithm.
  --runscmfbiasedmc <true/false>  
+
  --runscmfbiasedmc <true/false> Defaults to false. Runs a Biased Monte Carlo search using the SCMF probabilities.
  --rununbiasedmc <true/false>
+
  --rununbiasedmc <true/false> Defaults to true. Runs a Monte Carlo Simulated Annealing algorithm.
--excludeenergyterm <term1> --excludeenergyterm <term2>
 
  [Terms can be CHARMM_ANGL,CHARMM_BOND,CHARMM_DIHE,CHARMM_ELEC,CHARMM_IMPR,CHARMM_U-BR,CHARMM_VDW,SCWRL4_HBOND] All terms are implemented by default
 
  
 
Optional MC Parameters  
 
Optional MC Parameters  
Line 46: Line 44:
 
  --mcdeltasteps <numsteps>  
 
  --mcdeltasteps <numsteps>  
 
  --mcmindeltaenergy <minEnergy>
 
  --mcmindeltaenergy <minEnergy>
 +
 +
--excludeenergyterm <term1> --excludeenergyterm <term2>
 +
  [Terms can be CHARMM_ANGL,CHARMM_BOND,CHARMM_DIHE,CHARMM_ELEC,CHARMM_IMPR,CHARMM_U-BR,CHARMM_VDW,SCWRL4_HBOND] All terms are implemented by default
 +
  
 
Optional - Num of rotamers per residue type (-ve or 0 means the wt rotamer alone will be used)
 
Optional - Num of rotamers per residue type (-ve or 0 means the wt rotamer alone will be used)
 +
--rotlevel <SL85.00> (See your rotamer file for available rotamer levels)
 
  --ALA <nALA>
 
  --ALA <nALA>
 
  --ARG <nARG>  
 
  --ARG <nARG>  
Line 58: Line 61:
  
 
== Details ==
 
== Details ==
repacking will ...
+
 +
The repack side chains program takes a pdb file and optimizes all sidechain conformations.
 +
It uses discrete conformations from a rotamer library, and using state-of-the-art algorithms, repacks sidechains onto the input backbone structure.
 +
 
  
  
 
==Examples==
 
==Examples==
  
  > '''./repackSideChains --pdbfile 1A2J-for-repack-mini.pdb --rotlibfile rotlib-bonded_vdw_hb.txt --charmmtopfile top_all22_prot.inp --charmmparfile par_all22_prot.inp --hbondparfile canonical.inp --excludeenergyterm CHARMM_ELEC --printstats true --includecrystalrotamer true --ALA=-1 --GLY=-1 --PRO=-1 --outputpdbfile 1A2J_with_cr_except_elec'''
+
  > '''./repackSideChains --pdbfile 1A2J-for-repack-mini.pdb --rotlibfile rotlib-bonded_vdw_hb.txt --charmmtopfile top_all22_prot.inp --charmmparfile par_all22_prot.inp  
 +
  '''--hbondparfile canonical.inp --excludeenergyterm CHARMM_ELEC --printstats true --includecrystalrotamer true --ALA=-1 --GLY=-1 --PRO=-1 --outputpdbfile 1A2J_repacked.pdb
 +
 
 +
> '''./repackSideChains --pdbfile 1A2J-for-repack-mini.pdb
  
 
  ....
 
  ....

Latest revision as of 19:21, 10 July 2012

repackSideChains

A program to repack side chains of an input structure.


Options

--pdbfile <pdbfile>  - PDB structure to analyze. Should have PDB format and CHARMM names for all atoms.

Optional Parameters

--rotlibfile <rotlibfile> - RotamerLibrary file in MSL format (defaults to $MSL_DIR/library/EBL_11-2011_CHARMM22.txt).
--charmmtopfile <charmmTopFile> - CHARMM Topology file (defaults to $MSL_DIR/toppar/charmm22.top).
--charmmparfile <charmmParFile> - CHARMM parameter file (defaults to $MSL_DIR/toppar/charmm22.par).
--hbondparfile <hbondParFile> - Hydrogen bond parameters file (defaults to $MSL_DIR/toppar/scwrl4hb/par_hbond_1.txt).
--outputpdbfile <outputpdbfile> - Creates a pdb file with the best(lowest energy) structure obtained. Should be specified for most applications.
--logfile <logfile> - The output may be written to a text file. (Does not write the structure out. Prints the original and recovered values for chi dihedrals )
--verbose <true/false> - Prints additional information during the optimization process.

Non bonded interactions - thresholds

--cuton <nbcuton> defaults to 9.0
--cutoff <nbcutoff> defaults to 10.0
--cutnb <nbcutnb> defaults to 11.0

No interactions between atoms that are greater than cutnb Angstroms apart. All interactions at distances between cutoff and cutnb have zero energy but the interactions are maintained by the CharmmSystemBuilder. All interactions between cuton and cutoff are weighted using a switching function.


--includecrystalrotamer <true/false> Specify if crystal rotamer should be considered during repack. Should be set to false(defaults to false) to evaluate sidechain recovery.
--configfile <configfile> All the options may be specified in a file.

Algorithms

--rungoldsteinsingles <true/false> Defaults to true. Dead End Elimination using Goldstein Singles.
--rungoldsteinpairs <true/false> Defaults to false. Dead End Elimination using Goldstein Pairs.
--runscmf <true/false> Defaults to true. Runs the Self Consistent Mean Field Algorithm.
--runscmfbiasedmc <true/false>  Defaults to false. Runs a Biased Monte Carlo search using the SCMF probabilities.
--rununbiasedmc <true/false> Defaults to true. Runs a Monte Carlo Simulated Annealing algorithm.

Optional MC Parameters

--mcstarttemp <startT> 
--mcendtemp <endT> 
--mccycles <numCycles> 
--mcshape <CONSTANT/LINEAR/EXPONENTIAL/SIGMOIDAL/SOFT> 
--mcmaxreject <numReject> 
--mcdeltasteps <numsteps> 
--mcmindeltaenergy <minEnergy>

--excludeenergyterm <term1> --excludeenergyterm <term2>

  [Terms can be CHARMM_ANGL,CHARMM_BOND,CHARMM_DIHE,CHARMM_ELEC,CHARMM_IMPR,CHARMM_U-BR,CHARMM_VDW,SCWRL4_HBOND] All terms are implemented by default 


Optional - Num of rotamers per residue type (-ve or 0 means the wt rotamer alone will be used)

--rotlevel <SL85.00> (See your rotamer file for available rotamer levels)
--ALA <nALA>
--ARG <nARG> 
.........
--HSD <nHSD>
--HSE <nHSD>
--HSP <nHSP> 
....... 
--VAL <nVAL>

Details

The repack side chains program takes a pdb file and optimizes all sidechain conformations. It uses discrete conformations from a rotamer library, and using state-of-the-art algorithms, repacks sidechains onto the input backbone structure.


Examples

> ./repackSideChains --pdbfile 1A2J-for-repack-mini.pdb --rotlibfile rotlib-bonded_vdw_hb.txt --charmmtopfile top_all22_prot.inp --charmmparfile par_all22_prot.inp 
  --hbondparfile canonical.inp --excludeenergyterm CHARMM_ELEC --printstats true --includecrystalrotamer true --ALA=-1 --GLY=-1 --PRO=-1 --outputpdbfile 1A2J_repacked.pdb
> ./repackSideChains --pdbfile 1A2J-for-repack-mini.pdb
....

Source from SourceForge

repackSideChains.h

repackSideChains.cpp


Documentation index