doc/3.2.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{Laboratory 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-1301, 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. It is recommeded to use Cmake
  86 to install whole package; please see Installation Guide.
  87
  88 \section{COMMAND LINE AND FILES}
  89 \label{sect:command}
  90
  91 For xdrf2pdb and xdrf2pdb-m, you'll need to prepare the UNRES sequence file in either one- or three-letter code.
  92
  93 \subsection{XDRF2PDB}
  94 \label{sect:command:xdrf2pdb}
  95
  96 Command line syntax:
  97
  98 xdrf2pdb one/three seqfile cxfile [freq] [start] [end] [pdbfile]
  99
 100 \begin{description}
 101
 102 \item{one or three} indicates in what format the sequence will be read
 103 \item{seqfile} -- the file with the sequence:
 104 \begin{itemize}
 105 \item one-letter format: 80A1
 106 \item three-letter format: 20(A3,1X)
 107 \end{itemize}
 108 Note that the sequence must match exactly the UNRES sequence.
 109 \item{cxfile} -- full name of the trajectory file with compressed Cartesian coordinates.
 110 \item{freq} (1) -- conformation sampling frequency (each freq-th conformation will be saved to PBD file.
 111 \item{start} (1) -- the first conformation to be saved to PDB file.
 112 \item{end} (1000000000) -- the last conformation to be saved to PDB file.
 113 \item{pdbfile} (cxfile with extension changed from cx to pdb) -- the output PDB file.
 114
 115 \end{description}
 116
 117 \subsection{XDRF2PDB-M}
 118 \label{sect:command:xdrf2pdb-m}
 119
 120 Command line syntax:
 121
 122 xdrf2pdb-m one/three seqfile cxfile [ntraj] [itraj] [pdbfile] [ifreq]
 123
 124 \begin{description}
 125
 126 \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).
 127 \item{ntraj} (1) -- number of trajectories in the multi-trajectory run.
 128 \item{itraj} (1) -- the number of trajectory to be extracted.
 129
 130 \end{description}
 131
 132 \subsection{XDRF2X}
 133 \label{sect:command:xdrf2x}
 134
 135 Command line syntax:
 136
 137 xdrf2x cxfile [is] [ie] [freq] $>$ x\_file
 138
 139 The meaning of the the arguments is as in section
 140 \ref{sect:command:xdrf2pdb}; the conformations are output in UNRES Cartesian coordinate format to stdout.
 141
 142 \subsection{XDRF2ANG}
 143 \label{sect:command:xdrf2ang}
 144
 145 Command line syntax:
 146
 147 xdrf2ang one/three seqfile cxfile [freq] [start] [end] [angfile]
 148
 149 The meaning of the first six parameters is as in section \ref{sect:command:xdrf2pdb} angfile is
 150         the name of the output angle file; is assigned cx file name with the cx
 151         extension changed to ang, if not present.
 152
 153 \section{SUPPORT}
 154 \label{sect:support}
 155
 156    Dr. Adam Liwo\\
 157    Faculty of Chemistry, University of Gdansk\\
 158    ul. Wita Stwosza 63, 80-308 Gdansk Poland.\\
 159    phone: +48 58 523 5124\\
 160    fax: +48 58 523 5012\\
 161    e-mail: \href{mailto:adam@sun1.chem.univ.gda.pl}{\textcolor{blue}{adam@sun1.chem.univ.gda.pl}}\\
 162
 163
 164
 165    Dr. Cezary Czaplewski\\
 166    Faculty of Chemistry, University of Gdansk\\
 167    ul. Wita Stwosza 63, 80-308 Gdansk Poland.\\
 168    phone: +48 58 523 5126\\
 169    fax: +48 58 523 5012\\
 170    e-mail: \href{mailto:cezary.czaplewski@ug.edu.pl}{cezary.czaplewski@ug.edu.pl}
 171
 172 Prepared by Adam Liwo, 11/26/11
 173
 174 \LaTeX version, 09/28/12
 175
 176 Revised by Adam Liwo, 12/04/14
 177
 178 \end{document}