doc/3.1/latex/conversionman.tex

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