Skip to content
Snippets Groups Projects
Manual.txt 3.93 KiB
Newer Older
sjplimp's avatar
sjplimp committed
<!-- HTML_ONLY -->
sjplimp's avatar
sjplimp committed
<TITLE>LAMMPS Users Manual</TITLE>
Steven J. Plimpton's avatar
Steven J. Plimpton committed
<META NAME="docnumber" CONTENT="16 Jul 2018 version">
sjplimp's avatar
sjplimp committed
<META NAME="author" CONTENT="http://lammps.sandia.gov - Sandia National Laboratories">
Axel Kohlmeyer's avatar
Axel Kohlmeyer committed
<META NAME="copyright" CONTENT="Copyright (2003) Sandia Corporation. This software and manual is distributed under the GNU General Public License.">
sjplimp's avatar
sjplimp committed
</HEAD>

<BODY>

<!-- END_HTML_ONLY -->

"LAMMPS WWW Site"_lws - "LAMMPS Documentation"_ld - "LAMMPS Commands"_lc :c

:link(lws,http://lammps.sandia.gov)
:link(ld,Manual.html)
:link(lc,Section_commands.html#comm)

:line

sjplimp's avatar
sjplimp committed

LAMMPS Documentation :c,h1
16 Mar 2018 version :c,h2
sjplimp's avatar
sjplimp committed

"What is a LAMMPS version?"_Manual_version.html
sjplimp's avatar
sjplimp committed

LAMMPS stands for Large-scale Atomic/Molecular Massively Parallel
Simulator.

LAMMPS is a classical molecular dynamics simulation code designed to
run efficiently on parallel computers.  It was developed originally at
Sandia National Laboratories, a US Department of Energy facility, with
sjplimp's avatar
sjplimp committed
funding from the DOE.  It is an open-source code, distributed freely
under the terms of the GNU Public License (GPL).

The "LAMMPS website"_lws has information about the code authors, a
"mail list"_http://lammps.sandia.gov where users can post questions,
and a "GitHub site"https://github.com/lammps/lammps where all LAMMPS
development is coordinated.

:line
sjplimp's avatar
sjplimp committed

"PDF file"_Manual.pdf of the entire manual, generated by
"htmldoc"_http://freecode.com/projects/htmldoc
sjplimp's avatar
sjplimp committed

The content for this manual is part of the LAMMPS distribution.
You can build a local copy of the Manual as HTML pages or a PDF file,
by following the steps on the "this page"_Build_manual.html.
sjplimp's avatar
sjplimp committed

There is also a "Developer.pdf"_Developer.pdf document which gives
a brief description of the basic code structure of LAMMPS.
sjplimp's avatar
sjplimp committed

:line

This manual is organized into the following sections.
sjplimp's avatar
sjplimp committed

Once you are familiar with LAMMPS, you may want to bookmark "this
page"_Commands.html since it gives quick access to a doc page for
every LAMMPS command.
sjplimp's avatar
sjplimp committed

<!-- RST

.. toctree::
   :maxdepth: 2
   :numbered:
sjplimp's avatar
 
sjplimp committed
   :caption: User Documentation
   :name: userdoc
   :includehidden:
Steve Plimpton's avatar
Steve Plimpton committed

sjplimp's avatar
sjplimp committed
   Section_start
   Section_commands
sjplimp's avatar
sjplimp committed

sjplimp's avatar
 
sjplimp committed
.. toctree::
   :caption: Index
   :name: index
   :hidden:

   commands
   fixes
   computes
   pairs
   bonds
   angles
   dihedrals
   impropers
sjplimp's avatar
sjplimp committed

Indices and tables
==================

* :ref:`genindex`
* :ref:`search`
Steve Plimpton's avatar
Steve Plimpton committed

sjplimp's avatar
sjplimp committed
END_RST -->

<!-- HTML_ONLY -->
"Introduction"_Intro.html :olb,l
sjplimp's avatar
sjplimp committed
"Getting started"_Section_start.html :l
  2.1 "What's in the LAMMPS distribution"_start_1 :ulb,b
  2.2 "Making LAMMPS"_start_2 :b
  2.3 "Making LAMMPS with optional packages"_start_3 :b
  2.4 "Building LAMMPS as a library"_start_4 :b
  2.5 "Running LAMMPS"_start_5 :b
  2.6 "Command-line options"_start_6 :b
  2.7 "Screen output"_start_7 :b
  2.8 "Tips for users of previous versions"_start_8 :ule,b
sjplimp's avatar
sjplimp committed
"Commands"_Section_commands.html :l
  3.1 "LAMMPS input script"_cmd_1 :ulb,b
  3.2 "Parsing rules"_cmd_2 :b
  3.3 "Input script structure"_cmd_3 :b
  3.4 "Commands listed by category"_cmd_4 :b
  3.5 "Commands listed alphabetically"_cmd_5 :ule,b
"Optional packages"_Packages.html :l
"Accelerate performance"_Speed.html :l
"How-to discussions"_Howto.html :l
"Example scripts"_Examples.html :l
"Auxiliary tools"_Tools.html :l
"Modify & extend LAMMPS"_Modify.html :l
"Use Python with LAMMPS"_Python.html :l
"Errors"_Errors.html :l
sjplimp's avatar
sjplimp committed
:ole

:link(start_1,Section_start.html#start_1)
:link(start_2,Section_start.html#start_2)
:link(start_3,Section_start.html#start_3)
:link(start_4,Section_start.html#start_4)
:link(start_5,Section_start.html#start_5)
:link(start_6,Section_start.html#start_6)
:link(start_7,Section_start.html#start_7)
:link(start_8,Section_start.html#start_8)

:link(cmd_1,Section_commands.html#cmd_1)
:link(cmd_2,Section_commands.html#cmd_2)
:link(cmd_3,Section_commands.html#cmd_3)
:link(cmd_4,Section_commands.html#cmd_4)
:link(cmd_5,Section_commands.html#cmd_5)

<!-- END_HTML_ONLY -->

</BODY>