doc/user/conversion_scripts.doc

   1 /*
   2 Highly Optimized Object-oriented Many-particle Dynamics -- Blue Edition
   3 (HOOMD-blue) Open Source Software License Copyright 2008-2011 Ames Laboratory
   4 Iowa State University and The Regents of the University of Michigan All rights
   5 reserved.
   6
   7 HOOMD-blue may contain modifications ("Contributions") provided, and to which
   8 copyright is held, by various Contributors who have granted The Regents of the
   9 University of Michigan the right to modify and/or distribute such Contributions.
  10
  11 You may redistribute, use, and create derivate works of HOOMD-blue, in source
  12 and binary forms, provided you abide by the following conditions:
  13
  14 * Redistributions of source code must retain the above copyright notice, this
  15 list of conditions, and the following disclaimer both in the code and
  16 prominently in any materials provided with the distribution.
  17
  18 * Redistributions in binary form must reproduce the above copyright notice, this
  19 list of conditions, and the following disclaimer in the documentation and/or
  20 other materials provided with the distribution.
  21
  22 * All publications and presentations based on HOOMD-blue, including any reports
  23 or published results obtained, in whole or in part, with HOOMD-blue, will
  24 acknowledge its use according to the terms posted at the time of submission on:
  25 http://codeblue.umich.edu/hoomd-blue/citations.html
  26
  27 * Any electronic documents citing HOOMD-Blue will link to the HOOMD-Blue website:
  28 http://codeblue.umich.edu/hoomd-blue/
  29
  30 * Apart from the above required attributions, neither the name of the copyright
  31 holder nor the names of HOOMD-blue's contributors may be used to endorse or
  32 promote products derived from this software without specific prior written
  33 permission.
  34
  35 Disclaimer
  36
  37 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS ``AS IS'' AND
  38 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  39 WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND/OR ANY
  40 WARRANTIES THAT THIS SOFTWARE IS FREE OF INFRINGEMENT ARE DISCLAIMED.
  41
  42 IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  43 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  44 BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  45 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  46 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  47 OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  48 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  49 */
  50
  51 /*! \page page_conversion_scripts File Format Conversion
  52
  53 \section sec_hoomd_vmd_plugin Reading and converting HOOMD-blue XML files with VMD
  54
  55 As of version 1.8.7 the VMD molecular visualization software supports the HOOMD-blue XML format natively with read
  56 and write support through its molfile plugin library and can be used to build systems and convert between
  57 MD and visualization codes as well. Here are some examples using this:
  58
  59 \subsection sec_hoomd_vmd_structure Read a HOOMD-blue XML file into a VMD molecule
  60
  61 Load the structure \c file.xml into VMD, then add the trajectory frames in \c dump.dcd.
  62 \code
  63   mol new file.xml type hoomd waitfor all
  64   mol addfile dump.dcd type dcd wairfor all
  65 \endcode
  66
  67
  68 \subsection sec_hoomd_vmd_input Converting from a HOOMD-blue XML file to a LAMMPS input file
  69
  70 Load \c file.xml into VMD, then use topotools write out \c file.data in the LAMMPS molecular format
  71 \code
  72   package require topotools 1.0
  73   mol new file.xml type hoomd waitfor all
  74   topo writelammpsdata file.data molecular
  75 \endcode
  76
  77 \subsection sec_hoomd_vmd_data Converting from a series of HOOMD XML files to a LAMMPS dump file
  78
  79 Load a trajectory \c file*.xml into VMD, one frame at a time.
  80 Then use topotools write out \c file.dump in the LAMMPS dump format
  81 \code
  82   set first 1
  83   foreach f [glob file*.xml] {
  84      if {$first} {
  85          mol new $f type hoomd waitfor all
  86          set first 0
  87      } else {
  88          mol addfile $f type hoomd waitfor all
  89      }
  90   }
  91   animate write lammpstrj file.dump waitfor all
  92 \endcode
  93
  94 This conversion can also be done into all other formats that have write support in VMD, e.g. psf, pdb, dcd.
  95 Since pymol also uses the VMD molfile library, it eventually will also have native support for HOOMD-blue XML files added.
  96
  97 \subsection sec_hoomd_vmd_inverse Converting from a LAMMPS input file to HOOMD-blue XML
  98
  99 Load the LAMMPS input file \c file.data into VMD, then use topotools write out \c file.xml in the HOOMD-blue XML format.
 100 \code
 101   package require topotools 1.0
 102   topo readlammpsdata file.data molecular
 103   animate write hoomd file.xml waitfor all
 104 \endcode
 105
 106 */