doc/XDRFPDB.TXT

   1           XDRF2PDB, XDRF2PDB-M, XDRF2X - programs to convert compressed
   2           Cartesian coordinate files from UNRES into ASCII formats
   3           ------------------------------------------------------------
   4
   5 TABLE OF CONTENTS
   6 -----------------
   7
   8 1. License terms
   9
  10 2. Programs and their functions
  11
  12 3. Installation
  13
  14 4. Command lines and files
  15    4.1 xdrf2pdb
  16    4.2 xdrf2pdb-m
  17    4.3 xdrf2x
  18    4.4 xdrf2ang
  19
  20 5. Support
  21
  22 1. LICENSE TERMS
  23 ----------------
  24
  25 * This software is provided free of charge to academic users, subject to the
  26   condition that no part of it be sold or used otherwise for commercial
  27   purposes, including, but not limited to its incorporation into commercial
  28   software packages, without written consent from the authors. For permission
  29   contact Prof. H. A. Scheraga, Cornell University.
  30
  31 * This software package is provided on an "as is" basis. We in no way warrant
  32   either this software or results it may produce.
  33
  34 * Reports or publications using this software package must contain an
  35   acknowledgment to the authors and the NIH Resource in the form commonly
  36 used
  37   in academic research.
  38
  39 2. PROGRAMS AND THEIR FUNCTONS
  40 ------------------------------
  41
  42 The following three programs can be used to extract conformations from
  43 compressed Cartesian (cx) files from UNRES:
  44
  45 xdrf2pdb - takes a single trajectory file and converts it into PDB format.
  46
  47 xdrf2pdb-m - takes a multiple-trajectory file from UNRES/MREMD simulations
  48            and enables the user to extract conformation of a particular
  49            trajectory and save them to a PDB file.
  50
  51 xdrf2x - takes a single trajectory file and converts it into UNRES Cartesian
  52            coordinate (x) format
  53
  54 xdrf2ang - takes a single trajectory file and calculates UNRES backbone
  55          angles (theta and gamma).
  56
  57 3. INSTALLATION
  58 ---------------
  59
  60 Run make all on your system to install all programs or make <program>
  61 to install a particular program. You might need to run make in the
  62 xdrf subdirectory beforehand or point to the xdrf library that is on another
  63 directory in the Makefile.
  64
  65 The program compiles on all known Fortran compilers, including gfortran.
  66
  67 4. COMMAND LINE AND FILES
  68 -------------------------
  69
  70 For xdrf2pdb and xdrf2pdb-m, you'll need to prepare the UNRES sequence file
  71 in either one- or three-letter code.
  72
  73 4.1 XDRF2PDB
  74
  75 Command line syntax:
  76
  77 xdrf2pdb one/three seqfile cxfile [freq] [start] [end] [pdbfile]
  78
  79 where
  80
  81 one or three indicates in what format the sequence will be read
  82
  83 seqfile - the file with the sequence:
  84
  85 one-letter format: 80A1
  86
  87 three-letter format: 20(A3,1X)
  88
  89 Note that the sequence must match exactly the UNRES sequence
  90
  91 cxfile - full name of the trajectory file with compressed Cartesian coordinates.
  92
  93 freq (1) - conformation sampling frequency (each freq-th conformation will
  94         be saved to PBD file
  95
  96 start (1)  - the first conformation to be saved to PDB file
  97
  98 end (1000000000) the last conformation to be saved to PDB file
  99
 100 pdbfile (cxfile with extension changed from cx to pdb) - the output PDB file
 101
 102 4.2 XDRF2PDB-M
 103
 104 Command line syntax:
 105 xdrf2pdb-m xdrf2pdb-m one/three seqfile cxfile ntraj itraj [pdbfile] [freq]
 106
 107 cxfile - the name of the compressed trajectory file from an UNRES/MREMD run
 108          carried out with TRAJ1FILE (conformations from all trajectories
 109          output to a single file)
 110
 111 ntraj - number of trajectories in the multi-trajectory run
 112
 113 itraj - the number of trajectory to be extracted
 114
 115 pdbfile - (cxfile-without-cx-itraj.pdb) the name of file to write the Cartesian
 116         coordinates of trajectory itraj to
 117
 118 freq (1) - output frequency
 119
 120 The xdrf2pdb program to convert cx files to pdb files
 121
 122 The source is in xdrf2pdb; it requires the libraries in xdrf
 123
 124 4.3 XDRF2X
 125
 126 Command line syntax:
 127
 128 xdrf2x cxfile [is] [ie] [freq] > x_file
 129
 130 The meaning of the the arguments is as in section 4.1; the conformations
 131 are output in UNRES Cartesian coordinate format to stdout.
 132
 133 4.4. XDRF2ANG
 134
 135 Command line syntax:
 136
 137 xdrf2ang one/three seqfile cxfile [freq] [start] [end] [angfile]
 138
 139 The meaning of the first six parameters is as in section 4.1; angfile is
 140 the name of the output angle file; is assigned cx file name with the cx
 141 extension changed to ang, if not present.
 142
 143 5. SUPPORT
 144 ----------
 145
 146    Dr. Adam Liwo
 147    Faculty of Chemistry, University of Gdansk
 148    ul. Sobieskiego 18, 80-952 Gdansk Poland.
 149    phone: +48 58 523 5430
 150    fax: +48 58 523 5472
 151    e-mail: adam@chem.univ.gda.pl
 152
 153    Dr. Cezary Czaplewski
 154    Faculty of Chemistry, University of Gdansk
 155    ul. Sobieskiego 18, 80-952 Gdansk Poland.
 156    phone: +48 58 523 5430
 157    fax: +48 58 523 5472
 158    e-mail: czarek@chem.univ.gda.pl
 159
 160 Prepared by Adam Liwo, 11/26/11