doc/src/Manual.txt

   1 <!-- HTML_ONLY -->
   2 <HEAD>
   3 <TITLE>LAMMPS Users Manual</TITLE>
   4 <META NAME="docnumber" CONTENT="26 Jan 2017 version">
   5 <META NAME="author" CONTENT="http://lammps.sandia.gov - Sandia National Laboratories">
   6 <META NAME="copyright" CONTENT="Copyright (2003) Sandia Corporation.  This software and manual is distributed under the GNU General Public License.">
   7 </HEAD>
   8
   9 <BODY>
  10
  11 <!-- END_HTML_ONLY -->
  12
  13 "LAMMPS WWW Site"_lws - "LAMMPS Documentation"_ld - "LAMMPS Commands"_lc :c
  14
  15 :link(lws,http://lammps.sandia.gov)
  16 :link(ld,Manual.html)
  17 :link(lc,Section_commands.html#comm)
  18
  19 :line
  20
  21 <H1></H1>
  22
  23 LAMMPS Documentation :c,h3
  24 26 Jan 2017 version :c,h4
  25
  26 Version info: :h4
  27
  28 The LAMMPS "version" is the date when it was released, such as 1 May
  29 2010. LAMMPS is updated continuously.  Whenever we fix a bug or add a
  30 feature, we release it immediately, and post a notice on "this page of
  31 the WWW site"_bug. Every 2-4 months one of the incremental releases
  32 is subjected to more thorough testing and labeled as a {stable} version.
  33
  34 Each dated copy of LAMMPS contains all the
  35 features and bug-fixes up to and including that version date. The
  36 version date is printed to the screen and logfile every time you run
  37 LAMMPS. It is also in the file src/version.h and in the LAMMPS
  38 directory name created when you unpack a tarball, and at the top of
  39 the first page of the manual (this page).
  40
  41 If you browse the HTML doc pages on the LAMMPS WWW site, they always
  42 describe the most current version of LAMMPS. :ulb,l
  43
  44 If you browse the HTML doc pages included in your tarball, they
  45 describe the version you have. :l
  46
  47 The "PDF file"_Manual.pdf on the WWW site or in the tarball is updated
  48 about once per month.  This is because it is large, and we don't want
  49 it to be part of every patch. :l
  50
  51 There is also a "Developer.pdf"_Developer.pdf file in the doc
  52 directory, which describes the internal structure and algorithms of
  53 LAMMPS.  :l
  54 :ule
  55
  56 LAMMPS stands for Large-scale Atomic/Molecular Massively Parallel
  57 Simulator.
  58
  59 LAMMPS is a classical molecular dynamics simulation code designed to
  60 run efficiently on parallel computers.  It was developed at Sandia
  61 National Laboratories, a US Department of Energy facility, with
  62 funding from the DOE.  It is an open-source code, distributed freely
  63 under the terms of the GNU Public License (GPL).
  64
  65 The current core group of LAMMPS developers is at Sandia National
  66 Labs and Temple University:
  67
  68 "Steve Plimpton"_sjp, sjplimp at sandia.gov :ulb,l
  69 Aidan Thompson, athomps at sandia.gov :l
  70 Stan Moore, stamoore at sandia.gov :l
  71 "Axel Kohlmeyer"_ako, akohlmey at gmail.com :l
  72 :ule
  73
  74 Past core developers include Paul Crozier, Ray Shan and Mark Stevens,
  75 all at Sandia. The [LAMMPS home page] at
  76 "http://lammps.sandia.gov"_http://lammps.sandia.gov has more information
  77 about the code and its uses. Interaction with external LAMMPS developers,
  78 bug reports and feature requests are mainly coordinated through the
  79 "LAMMPS project on GitHub."_https://github.com/lammps/lammps
  80 The lammps.org domain, currently hosting "public continuous integration
  81 testing"_https://ci.lammps.org/job/lammps/ and "precompiled Linux
  82 RPM and Windows installer packages"_http://rpm.lammps.org is located
  83 at Temple University and managed by Richard Berger,
  84 richard.berger at temple.edu.
  85
  86 :link(bug,http://lammps.sandia.gov/bug.html)
  87 :link(sjp,http://www.sandia.gov/~sjplimp)
  88 :link(ako,http://goo.gl/1wk0)
  89
  90 :line
  91
  92 The LAMMPS documentation is organized into the following sections.  If
  93 you find errors or omissions in this manual or have suggestions for
  94 useful information to add, please send an email to the developers so
  95 we can improve the LAMMPS documentation.
  96
  97 Once you are familiar with LAMMPS, you may want to bookmark "this
  98 page"_Section_commands.html#comm at Section_commands.html#comm since
  99 it gives quick access to documentation for all LAMMPS commands.
 100
 101 "PDF file"_Manual.pdf of the entire manual, generated by
 102 "htmldoc"_http://freecode.com/projects/htmldoc
 103
 104 <!-- RST
 105
 106 .. toctree::
 107    :maxdepth: 2
 108    :numbered:
 109    :caption: User Documentation
 110    :name: userdoc
 111    :includehidden:
 112
 113    Section_intro
 114    Section_start
 115    Section_commands
 116    Section_packages
 117    Section_accelerate
 118    Section_howto
 119    Section_example
 120    Section_perf
 121    Section_tools
 122    Section_modify
 123    Section_python
 124    Section_errors
 125    Section_history
 126
 127 .. toctree::
 128    :caption: Index
 129    :name: index
 130    :hidden:
 131
 132    tutorials
 133    commands
 134    fixes
 135    computes
 136    pairs
 137    bonds
 138    angles
 139    dihedrals
 140    impropers
 141
 142 Indices and tables
 143 ==================
 144
 145 * :ref:`genindex`
 146 * :ref:`search`
 147
 148 END_RST -->
 149
 150 <!-- HTML_ONLY -->
 151 "Introduction"_Section_intro.html :olb,l
 152   1.1 "What is LAMMPS"_intro_1 :ulb,b
 153   1.2 "LAMMPS features"_intro_2 :b
 154   1.3 "LAMMPS non-features"_intro_3 :b
 155   1.4 "Open source distribution"_intro_4 :b
 156   1.5 "Acknowledgments and citations"_intro_5 :ule,b
 157 "Getting started"_Section_start.html :l
 158   2.1 "What's in the LAMMPS distribution"_start_1 :ulb,b
 159   2.2 "Making LAMMPS"_start_2 :b
 160   2.3 "Making LAMMPS with optional packages"_start_3 :b
 161   2.4 "Building LAMMPS via the Make.py script"_start_4 :b
 162   2.5 "Building LAMMPS as a library"_start_5 :b
 163   2.6 "Running LAMMPS"_start_6 :b
 164   2.7 "Command-line options"_start_7 :b
 165   2.8 "Screen output"_start_8 :b
 166   2.9 "Tips for users of previous versions"_start_9 :ule,b
 167 "Commands"_Section_commands.html :l
 168   3.1 "LAMMPS input script"_cmd_1 :ulb,b
 169   3.2 "Parsing rules"_cmd_2 :b
 170   3.3 "Input script structure"_cmd_3 :b
 171   3.4 "Commands listed by category"_cmd_4 :b
 172   3.5 "Commands listed alphabetically"_cmd_5 :ule,b
 173 "Packages"_Section_packages.html :l
 174   4.1 "Standard packages"_pkg_1 :ulb,b
 175   4.2 "User packages"_pkg_2 :ule,b
 176 "Accelerating LAMMPS performance"_Section_accelerate.html :l
 177   5.1 "Measuring performance"_acc_1 :ulb,b
 178   5.2 "Algorithms and code options to boost performace"_acc_2 :b
 179   5.3 "Accelerator packages with optimized styles"_acc_3 :b
 180     5.3.1 "GPU package"_accelerate_gpu.html :ulb,b
 181     5.3.2 "USER-INTEL package"_accelerate_intel.html :b
 182     5.3.3 "KOKKOS package"_accelerate_kokkos.html :b
 183     5.3.4 "USER-OMP package"_accelerate_omp.html :b
 184     5.3.5 "OPT package"_accelerate_opt.html :ule,b
 185   5.4 "Comparison of various accelerator packages"_acc_4 :ule,b
 186 "How-to discussions"_Section_howto.html :l
 187   6.1 "Restarting a simulation"_howto_1 :ulb,b
 188   6.2 "2d simulations"_howto_2 :b
 189   6.3 "CHARMM and AMBER force fields"_howto_3 :b
 190   6.4 "Running multiple simulations from one input script"_howto_4 :b
 191   6.5 "Multi-replica simulations"_howto_5 :b
 192   6.6 "Granular models"_howto_6 :b
 193   6.7 "TIP3P water model"_howto_7 :b
 194   6.8 "TIP4P water model"_howto_8 :b
 195   6.9 "SPC water model"_howto_9 :b
 196   6.10 "Coupling LAMMPS to other codes"_howto_10 :b
 197   6.11 "Visualizing LAMMPS snapshots"_howto_11 :b
 198   6.12 "Triclinic (non-orthogonal) simulation boxes"_howto_12 :b
 199   6.13 "NEMD simulations"_howto_13 :b
 200   6.14 "Finite-size spherical and aspherical particles"_howto_14 :b
 201   6.15 "Output from LAMMPS (thermo, dumps, computes, fixes, variables)"_howto_15 :b
 202   6.16 "Thermostatting, barostatting, and compute temperature"_howto_16 :b
 203   6.17 "Walls"_howto_17 :b
 204   6.18 "Elastic constants"_howto_18 :b
 205   6.19 "Library interface to LAMMPS"_howto_19 :b
 206   6.20 "Calculating thermal conductivity"_howto_20 :b
 207   6.21 "Calculating viscosity"_howto_21 :b
 208   6.22 "Calculating a diffusion coefficient"_howto_22 :b
 209   6.23 "Using chunks to calculate system properties"_howto_23 :b
 210   6.24 "Setting parameters for pppm/disp"_howto_24 :b
 211   6.25 "Polarizable models"_howto_25 :b
 212   6.26 "Adiabatic core/shell model"_howto_26 :b
 213   6.27 "Drude induced dipoles"_howto_27 :ule,b
 214 "Example problems"_Section_example.html :l
 215 "Performance & scalability"_Section_perf.html :l
 216 "Additional tools"_Section_tools.html :l
 217 "Modifying & extending LAMMPS"_Section_modify.html :l
 218   10.1 "Atom styles"_mod_1 :ulb,b
 219   10.2 "Bond, angle, dihedral, improper potentials"_mod_2 :b
 220   10.3 "Compute styles"_mod_3 :b
 221   10.4 "Dump styles"_mod_4 :b
 222   10.5 "Dump custom output options"_mod_5 :b
 223   10.6 "Fix styles"_mod_6 :b
 224   10.7 "Input script commands"_mod_7 :b
 225   10.8 "Kspace computations"_mod_8 :b
 226   10.9 "Minimization styles"_mod_9 :b
 227   10.10 "Pairwise potentials"_mod_10 :b
 228   10.11 "Region styles"_mod_11 :b
 229   10.12 "Body styles"_mod_12 :b
 230   10.13 "Thermodynamic output options"_mod_13 :b
 231   10.14 "Variable options"_mod_14 :b
 232   10.15 "Submitting new features for inclusion in LAMMPS"_mod_15 :ule,b
 233 "Python interface"_Section_python.html :l
 234   11.1 "Overview of running LAMMPS from Python"_py_1 :ulb,b
 235   11.2 "Overview of using Python from a LAMMPS script"_py_2 :b
 236   11.3 "Building LAMMPS as a shared library"_py_3 :b
 237   11.4 "Installing the Python wrapper into Python"_py_4 :b
 238   11.5 "Extending Python with MPI to run in parallel"_py_5 :b
 239   11.6 "Testing the Python-LAMMPS interface"_py_6 :b
 240   11.7 "Using LAMMPS from Python"_py_7 :b
 241   11.8 "Example Python scripts that use LAMMPS"_py_8 :ule,b
 242 "Errors"_Section_errors.html :l
 243   12.1 "Common problems"_err_1 :ulb,b
 244   12.2 "Reporting bugs"_err_2 :b
 245   12.3 "Error & warning messages"_err_3 :ule,b
 246 "Future and history"_Section_history.html :l
 247   13.1 "Coming attractions"_hist_1 :ulb,b
 248   13.2 "Past versions"_hist_2 :ule,b
 249 :ole
 250
 251 :link(intro_1,Section_intro.html#intro_1)
 252 :link(intro_2,Section_intro.html#intro_2)
 253 :link(intro_3,Section_intro.html#intro_3)
 254 :link(intro_4,Section_intro.html#intro_4)
 255 :link(intro_5,Section_intro.html#intro_5)
 256
 257 :link(start_1,Section_start.html#start_1)
 258 :link(start_2,Section_start.html#start_2)
 259 :link(start_3,Section_start.html#start_3)
 260 :link(start_4,Section_start.html#start_4)
 261 :link(start_5,Section_start.html#start_5)
 262 :link(start_6,Section_start.html#start_6)
 263 :link(start_7,Section_start.html#start_7)
 264 :link(start_8,Section_start.html#start_8)
 265 :link(start_9,Section_start.html#start_9)
 266
 267 :link(cmd_1,Section_commands.html#cmd_1)
 268 :link(cmd_2,Section_commands.html#cmd_2)
 269 :link(cmd_3,Section_commands.html#cmd_3)
 270 :link(cmd_4,Section_commands.html#cmd_4)
 271 :link(cmd_5,Section_commands.html#cmd_5)
 272
 273 :link(pkg_1,Section_packages.html#pkg_1)
 274 :link(pkg_2,Section_packages.html#pkg_2)
 275
 276 :link(acc_1,Section_accelerate.html#acc_1)
 277 :link(acc_2,Section_accelerate.html#acc_2)
 278 :link(acc_3,Section_accelerate.html#acc_3)
 279 :link(acc_4,Section_accelerate.html#acc_4)
 280
 281 :link(howto_1,Section_howto.html#howto_1)
 282 :link(howto_2,Section_howto.html#howto_2)
 283 :link(howto_3,Section_howto.html#howto_3)
 284 :link(howto_4,Section_howto.html#howto_4)
 285 :link(howto_5,Section_howto.html#howto_5)
 286 :link(howto_6,Section_howto.html#howto_6)
 287 :link(howto_7,Section_howto.html#howto_7)
 288 :link(howto_8,Section_howto.html#howto_8)
 289 :link(howto_9,Section_howto.html#howto_9)
 290 :link(howto_10,Section_howto.html#howto_10)
 291 :link(howto_11,Section_howto.html#howto_11)
 292 :link(howto_12,Section_howto.html#howto_12)
 293 :link(howto_13,Section_howto.html#howto_13)
 294 :link(howto_14,Section_howto.html#howto_14)
 295 :link(howto_15,Section_howto.html#howto_15)
 296 :link(howto_16,Section_howto.html#howto_16)
 297 :link(howto_17,Section_howto.html#howto_17)
 298 :link(howto_18,Section_howto.html#howto_18)
 299 :link(howto_19,Section_howto.html#howto_19)
 300 :link(howto_20,Section_howto.html#howto_20)
 301 :link(howto_21,Section_howto.html#howto_21)
 302 :link(howto_22,Section_howto.html#howto_22)
 303 :link(howto_23,Section_howto.html#howto_23)
 304 :link(howto_24,Section_howto.html#howto_24)
 305 :link(howto_25,Section_howto.html#howto_25)
 306 :link(howto_26,Section_howto.html#howto_26)
 307 :link(howto_27,Section_howto.html#howto_27)
 308
 309 :link(mod_1,Section_modify.html#mod_1)
 310 :link(mod_2,Section_modify.html#mod_2)
 311 :link(mod_3,Section_modify.html#mod_3)
 312 :link(mod_4,Section_modify.html#mod_4)
 313 :link(mod_5,Section_modify.html#mod_5)
 314 :link(mod_6,Section_modify.html#mod_6)
 315 :link(mod_7,Section_modify.html#mod_7)
 316 :link(mod_8,Section_modify.html#mod_8)
 317 :link(mod_9,Section_modify.html#mod_9)
 318 :link(mod_10,Section_modify.html#mod_10)
 319 :link(mod_11,Section_modify.html#mod_11)
 320 :link(mod_12,Section_modify.html#mod_12)
 321 :link(mod_13,Section_modify.html#mod_13)
 322 :link(mod_14,Section_modify.html#mod_14)
 323 :link(mod_15,Section_modify.html#mod_15)
 324
 325 :link(py_1,Section_python.html#py_1)
 326 :link(py_2,Section_python.html#py_2)
 327 :link(py_3,Section_python.html#py_3)
 328 :link(py_4,Section_python.html#py_4)
 329 :link(py_5,Section_python.html#py_5)
 330 :link(py_6,Section_python.html#py_6)
 331
 332 :link(err_1,Section_errors.html#err_1)
 333 :link(err_2,Section_errors.html#err_2)
 334 :link(err_3,Section_errors.html#err_3)
 335
 336 :link(hist_1,Section_history.html#hist_1)
 337 :link(hist_2,Section_history.html#hist_2)
 338 <!-- END_HTML_ONLY -->
 339
 340 </BODY>