home *** CD-ROM | disk | FTP | other *** search
/ Dream 44 / Amiga_Dream_44.iso / Amiga / pov / utils / pdb2pov_121.lha / babel.doc < prev    next >
Text File  |  1994-01-23  |  12KB  |  339 lines

  1.           Babel version 1.03 Copyright (C) 1992,1993,1994
  2.                   by
  3.               Pat Walters and Matt Stahl
  4.  
  5.             Dolata Research Group
  6.                Department of Chemistry
  7.             University of Arizona
  8.                Tucson, AZ 85721
  9.            babel@mercury.aichem.arizona.edu
  10.  
  11.  
  12.  
  13.  
  14. This software is provided on an "as is" basis, and without warranty of any 
  15. kind, including but not limited to any implied warranty of merchantability 
  16. or fitness for a particular purpose.
  17.  
  18. In no event shall the authors or the University of Arizona be liable for 
  19. any direct, indirect, incidental, special, or consequential damages arising 
  20. from use or distribution of this software. The University of Arizona also 
  21. shall not be liable for any claim against any user of this program by any 
  22. third party.
  23.  
  24.  
  25. PLEASE REGISTER
  26.  
  27. We don't want any money for Babel (unless of course you insist), but we
  28. would like to know who has a copy so that we can notify people about updates 
  29. and bug fixes.
  30.  
  31. You can register by sending e-mail to babel@mercury.aichem.arizona.edu and 
  32. letting us know the following:
  33.     -who you are
  34.     -where you are
  35.     -what platform you're running Babel on
  36.     -which file conversions you commonly use
  37.  
  38. We are very open to suggestions.  If there's anything you like or don't 
  39. like about the program please let us know.  Also if there are file formats
  40. you would like to see supported let us know.
  41. --------------------------------------------------------------------------
  42.  
  43. Thanks for downloading this copy of babel.  With this program we hope to
  44. implement a general framework for converting between file formats used 
  45. for molecular modeling.  This is the first version of the manual, and 
  46. we are sorry to say that it's rather meager.  However, the program is very 
  47. easy to use and we're sure that by scanning over these few pages you'll
  48. be babbling away before you know it.   This manual is divided into 3 
  49. sections.
  50.  
  51. I. Installation
  52. II. Using Babel
  53. III. Other Stuff
  54.  
  55. I. INSTALLATION
  56. UNIX INSTALLATION
  57. Installation is very simple. 
  58.  
  59. 1. Special Instructions - Unless you have a Sun Workstaion with an old
  60. Sabre C compiler (or other non-ansi C compiler) or a Dec machine running
  61. Ultrix goto step 2.
  62.  
  63. SUN WORKSTATIONS WITH THE OLD (NON-ANSI) SABRE C COMPILER
  64. If you have a Sun workstation with the old Sabre C compiler or another
  65. non-ANSI C-compiler you must use gcc to compile babel. If you are using
  66. gcc to compile babel, change line 10 in the makefile from
  67.  
  68. CC          = cc
  69.  
  70. to
  71.  
  72. CC          = gcc
  73.  
  74. DEC STATIONS RUNNING ULTRIX - If you have gcc follow the instructions above
  75. to use gcc as the compiler.  Otherwise change line 1 in the Makefile from
  76.  
  77. CFLAGS        = -O 
  78.  
  79. to
  80.  
  81. CFLAGS        = -O -ULTRIX
  82.  
  83. 2. Make the program by typing make.
  84. 3. Set the environment variable BABEL_DIR to point to the directory 
  85. where the files types.lis and elements.lis are stored.
  86. i.e. If the files are in /usr/local/babel type the following
  87.  
  88. setenv BABEL_DIR /usr/local/babel
  89.  
  90. If you plan to use babel frequently then you will probably want to
  91. place the line above in your .cshrc file.
  92.  
  93.  
  94. II. USING BABEL
  95.  
  96. The babel program may be invoked using command line options or menus. 
  97.  
  98. The menu interface can be accessed by typing:
  99. babel -m
  100.  
  101. The command line input has the following format:
  102. babel [-v] -i<itype> <infile> [keywords] -o<out type> <outfile> [keywords2]
  103.  
  104. All arguments surrounded by [] are optional.
  105. The -v flag is optional and is used to produce verbose output.
  106. The -i flag is used to set the input type.  The following input type codes
  107. are currently supported.
  108.  
  109.     ac -- Mopac Cartesian file
  110.     ao -- Mopac Output file
  111.     ai -- Mopac Internal file
  112.     c -- CSD GSTAT file
  113.     cf -- CSD CSSR file
  114.     f -- Free Form Fractional file
  115.     k -- Macromodel file
  116.     micro -- Micro World file
  117.     mo -- MM2 Ouput file
  118.     p -- PDB file
  119.     t -- Alchemy file
  120.     x -- XYZ file
  121.     prep -- AMBER PREP file
  122.     molin -- MOLIN file
  123.     boog -- Boogie file
  124.     caccrt -- Cacao Cartesian file
  125.     macmol -- Mac Molecule file
  126.     c3d1 -- Chem 3D Cartesian 1 file
  127.     c3d2 -- Chem 3D Cartesian 2 file
  128.     bs -- Ball and Stick file
  129.     g -- Gaussian Z-Matrix file
  130.     gauout -- Gaussian Output file
  131.     gamout -- GAMESS Output file
  132.     mmads -- MMADS file
  133.     shelx -- ShelX file
  134.     mol2 -- Sybyl Mol2 file
  135.     fdat -- CSD FDAT file
  136.     charmm -- CHARMm file
  137.     mdl -- MDL Molfile file
  138.  
  139. The -o flag is used to set the output file type.  The following output 
  140. type codes are currently supported.
  141.  
  142.     diag -- DIAGNOTICS file
  143.     ac -- Mopac Cartesian file
  144.     ai -- Mopac Internal file
  145.     g -- Gaussian Z-matrix file
  146.     gcart -- Gaussian Cartesian file
  147.     i -- IDATM file
  148.     k -- Macromodel file
  149.     macmol -- Mac Molecule file
  150.     micro -- Micro World file
  151.     mi -- MM2 Input file
  152.     mo -- MM2 Ouput file
  153.     p -- PDB file
  154.     report -- Report file
  155.     t -- Alchemy file
  156.     caccrt -- Cacao Cartesian file
  157.     x -- XYZ file
  158.     bs -- Ball and Stick file
  159.     c3d1 -- Chem 3D Cartesian 1 file
  160.     c3d2 -- Chem 3D Cartesian 2 file
  161.     d -- ChemDraw Connection Table file
  162.     mdl -- MDL Molfile file
  163.     gamin -- Gamess Input file
  164.     mmads -- MMADS file
  165.     mol2 -- Sybyl Mol2 file
  166.  
  167. To convert an MM2 output file named mm2.grf to a MOPAC internal coordinate 
  168. input file named mopac.dat the user would enter:
  169. babel -imo mm2.grf -oai mopac.dat
  170.  
  171. To perform the above conversion with the keywords PM3 GEO-OK T=30000 in the
  172. file mopac.dat the user would enter:
  173. babel -imo mm2.grf -oai mopac.dat "PM3 GEO-OK T=30000"
  174. Note the use of the double quotes around the keywords.
  175.  
  176. HYDROGEN ADDITION/DELETION
  177. Babel has the ability to add and delete hydrogens from any file format.  
  178. Hydrogens can be added by supplying the -h flag, hydrogens may be deleted 
  179. by supplying the -d flag.
  180.  
  181. To add hydrogens a CSD fractional coordinate file called input.cssr and 
  182. output the file as a MOPAC internal coordinate input file named output.add 
  183. the user would type:
  184. babel -icf input.cssr -h -oai output.add 
  185.  
  186. To delete hydrogens from a Macromodel file named benzene.dat and 
  187. output the file as an XYZ file name benzene.new the user would type
  188. babel -ik benzene.dat -d -ox benzene.new
  189.  
  190. MULTI-STRUCTURE FILES
  191. Babel will currently read multi-structure files produced by Macromodel.  
  192. With this type of file the user has two output options
  193.     - produce one output file for each structure in the file
  194.     - produce a multi-structure output file.
  195.  
  196. When converting a multi structure file it is necessary to supply a 
  197. keyword after the input file name.  This keyword specifies the number
  198. of files to extract from the iput file.  The keyword can be either a 
  199. number or the word all.  Hopefully the examples below will make this
  200. a little more clear.
  201.  
  202. To extract all the structures from a multi-structure Macromodel file 
  203. called mols.out and write the structures as pdb files the user would 
  204. type:
  205.  
  206. babel -ik mols.out all -op mols.pdb
  207. The output files would be written as mols1.pdb, mols2.pdb, etc.
  208.  
  209. To extract only the first five structures from a multi-structure 
  210. Macromodel file and write the structures as mopac internal coordinate
  211. file the user would type
  212. babel -ik mols.out 5 -oai mols.int
  213. The output files would be written as mols1.int, mols2.int. etc.
  214.  
  215. It is sometimes necessary to convert a mulit-structure Macromodel file
  216. into a multi-structure file of another type.  This can be a handy way of
  217. viewing Macromodel movies with the Xmol program.  Babel accomplishes 
  218. this by sending the output to the console using the output file name
  219. CON (note the use of uppercase letters).  Once again this is better 
  220. explained by an example.  To convert all the structures in a 
  221. multi-structure Macromodel file called mols.out to a multi-structure XYZ 
  222. file called mols.xyz the user would type:
  223. babel -ik mols.out all -ox CON > mols.xyz
  224.  
  225. MACMOLECULE FILES
  226. Since MacMolecule only uses single letter it is often necessary to use
  227. different names (i.e. X for Cl).  The user can specify substituted atom
  228. names on the command line.  
  229.  
  230. To read a MacMolecule file named foo.bar where X is substituted for Cl
  231. and Y is substitued for Cobalt and write an MM2 output type file named
  232. bar.baz the user would type:
  233. babel -imacmol "X/Cl Y/Co" foo.bar -omo bar.baz  
  234.  
  235. CHEMDRAW FILES
  236. The user can supply a keyword to indicate the viewing axis for the 
  237. ChemDraw projection by supplying a keyword.  To convert an XYZ file
  238. named test.xyz to a ChemDraw file named test.cdy with the view down the
  239. y axis the user would type:
  240. babel -ix test.xyz -od test.cdx x
  241.  
  242. The default view is down the z axis.  Babel will also write MDL Molfile
  243. type files which can be read by ChemDraw, ChemIntosh, ChemWindow, and 
  244. Chem3D.
  245.  
  246. GAMESS FILES
  247. ---GAMESS Output Files---
  248. The output files are the .log files created by redirecting screen output.  
  249. Babel first looks for a set of geometry optimized coordinates.  If the 
  250. output file does not contain geometry optimized coordiantes Babel will 
  251. use the input coordiantes. If Babel uses the input coordiantes it will 
  252. convert from Bohr to Angstroms.
  253.  
  254. To read a GAMESS output file named exam01.log and convert it to an XYZ 
  255. file named exam01.xyz the user would type:
  256. babel -igamout exam01.log -ox exam01.xyz
  257.  
  258. ---GAMESS Input Files---
  259. Babel is capable of creating three types of GAMESS input files
  260. COORD=CART Cartesian Coordinates
  261. COORD=ZMAT Gaussian Style Z-matrix
  262. COORD=ZMTPC MOPAC Style Z-matrix
  263.  
  264. Babel does not calculate the point group for you.  You'll have to pull
  265. out your copy of Cotton and insert that manually. You'll also have to 
  266. specify your own $SYSTEM, $BASIS, $SCF, $GUESS, etc. cards.
  267.  
  268. The type of input file is controlled by specifying a keyword on the 
  269. Babel command line.  The keywords are
  270.     cart - Cartesian 
  271.     zmt - Gaussian style Z-matrix
  272.     zmtmpc - MOPAC style Z-matrix
  273.  
  274. To read an xyz file named coords.xyz and convert it to a GAMESS input
  275. file in Cartesian coordiantes named coords.in the user would type:
  276. babel -ix coords.xzy -ogamin coords.in cart
  277.  
  278. To do the same conversion by have the GAMESS input in Gaussian Z-matrix
  279. style the user would type
  280. babel -ix coords.xzy -ogamin coords.in zmt
  281.  
  282. If no keyword is specified the input file will be in Cartesian Coordiantes.
  283.  
  284.  
  285. III. OTHER STUFF
  286. CURRENT LIMITATIONS
  287. Macromodel - bond orders are not always correctly assigned for conjugated
  288. pi systems.  
  289.  
  290. PDB files - When reading PDB files Babel assigns bonds are examining 
  291. interatomic distances and assigning a bond where the interatomic distance
  292. is less than the sum of the atoms convalent radii.  There is code in read_pdb.c
  293. to read connections specified in CONECT records, but this code is commented
  294. out.  We did this because a number of files available from Brookhaven have
  295. CONECT records specified for only a few of the bonds in the molecule.  We
  296. realize that we could determine connectivity in the PDB file by looking
  297. at atom ids and residue types, but we have put this in yet.  This feature 
  298. will probably be added soon.  If you would like to use the explicit CONECT
  299. records in a PDB file see Appendix A.  When writing PDB files all residue
  300. types are assigned as UNK.
  301.  
  302. REPORTING BUGS
  303. Noone is perfect, and we're sure that there are still a few glitches in this
  304. program.  If you happen to find such a glitch please send a mail message to
  305. babel@mercury.aichem.arizona.edu describing the nature of the problem.  If 
  306. possible please include the input file so we can use it to determine the 
  307. cause of the problem.
  308.  
  309. CREDIT WHERE CREDIT IS DUE
  310. Bable began it's life a program called convert written by Ajay Shah.  
  311. Babel in its current form was written by Pat Walters with some help 
  312. from Matt Stahl.
  313.  
  314. COMING ATTRACTIONS
  315. We consider Babel to be a constantly evolving program.  Hopefully 
  316. modules to handle new file formats will be contributed and the program 
  317. will become useful to an even wider range of chemists.  We currently have 
  318. a number of additions to Babel underway at the
  319. U of A.  Among these are:
  320. 1.  A real users manual 
  321. 2.  A developers guide which will assist programmers in creating new 
  322. modules (Actually I have finished a draft of the Babel Developers Guide.
  323. If you'd like a copy send me some mail - pat@mercury.aichem.arizona.edu).
  324.  
  325. PLEASE WRITE
  326. We would really appreciate any and all input from babel users.  Please
  327. send comments, praise, flames, and job offers :-) to 
  328. babel@mercury.aichem.arizona.edu
  329.  
  330. Have fun,
  331.  
  332. Pat Walters
  333. Chief Cook and Bottle-Washer
  334.  
  335.  
  336.  
  337.  
  338.  
  339.