Go to file
Stan Moore 073f003470 Doc tweak 2019-04-09 15:17:40 -06:00
.github small corrections/clarifications to the pull request template 2019-03-06 16:59:17 -05:00
bench update logs for eff and reax 2018-03-21 21:26:46 -04:00
cmake set default to automatically download scafacos lib if not found 2019-04-07 06:10:39 -04:00
doc Doc tweak 2019-04-09 15:17:40 -06:00
examples Merge remote-tracking branch 'upstream/master' into fix-elstop 2019-04-04 10:03:36 +03:00
lib update USER-PLUMED support for version 2.5.1 and fix bug in Install.py script 2019-04-04 14:19:53 -04:00
potentials Merge branch 'snap-foundtest' of https://github.com/athomps/lammps into collected-post-stable-patches 2018-12-12 00:16:36 -05:00
python prefix option in install.py not needed 2019-03-26 21:55:07 -04:00
src Reduce DELTA and revert subview change 2019-04-09 14:40:39 -06:00
tools document in README, that msi2lmp is now build alongside LAMMPS 2019-04-07 00:47:10 -04:00
.gitignore ignore valgrind core dumps 2018-11-28 21:22:46 -05:00
LICENSE LICENSE: update address of Free Software Foundation 2017-07-21 17:13:28 -06:00
README doc typos and push author details back to website 2018-08-17 09:15:21 -06:00

README

This is the LAMMPS software package.

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

Copyright (2003) Sandia Corporation.  Under the terms of Contract
DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government retains
certain rights in this software.  This software is distributed under
the GNU General Public License.

----------------------------------------------------------------------

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

The primary author of the code is Steve Plimpton, who can be emailed
at sjplimp@sandia.gov.  The LAMMPS WWW Site at lammps.sandia.gov has
more information about the code and its uses.

The LAMMPS distribution includes the following files and directories:

README			   this file
LICENSE			   the GNU General Public License (GPL)
bench			   benchmark problems
cmake			   CMake build system
doc			   documentation
examples		   simple test problems
lib			   libraries LAMMPS can be linked with
potentials		   interatomic potential files
python			   Python wrapper on LAMMPS as a library
src			   source files
tools			   pre- and post-processing tools

Point your browser at any of these files to get started:

http://lammps.sandia.gov/doc/Manual.html         the LAMMPS manual
http://lammps.sandia.gov/doc/Intro.html          hi-level introduction
http://lammps.sandia.gov/doc/Build.html          how to build LAMMPS
http://lammps.sandia.gov/doc/Run_head.html       how to run LAMMPS
http://lammps.sandia.gov/doc/Developer.pdf       LAMMPS developer guide

You can also create these doc pages locally:

% cd doc
% make html                # creates HTML pages in doc/html
% make pdf                 # creates Manual.pdf and Developer.pdf