Go to file
Axel Kohlmeyer 790f636523
rephrase
2020-09-23 15:45:29 -04:00
.github update specific pull request templates as they are available through the github cli now 2020-09-18 06:54:31 -04:00
bench FERMI GPU hardware is no longer supported by CUDA drivers and toolkit 2020-06-14 11:05:29 -04:00
cmake Simplify GenerateBinaryHeader utility 2020-09-20 18:24:43 -04:00
doc document -DLAMMPS_TRAP_FPE 2020-09-23 09:38:07 -04:00
examples modernize example 2020-09-20 14:03:13 -04:00
fortran no need to use a deprecated argument in a newly added API 2020-09-09 09:06:28 -04:00
lib remove obsolete makefiles. Makefile.xk7 is on death watch but Blue Waters still has such nodes 2020-09-22 17:47:14 -04:00
potentials add unit conversion to pair styles eim, gw, gw/zbl, and nb3b/harmonic 2020-06-28 16:49:23 -04:00
python correct reference to function 2020-09-18 22:35:56 -04:00
src rephrase 2020-09-23 15:45:29 -04:00
tools update a few more singularity container definitions for doc build requirements 2020-09-22 06:01:34 -04:00
unittest Merge branch 'collected-small-changes' of github.com:akohlmey/lammps into collected-small-changes 2020-09-20 19:20:42 -04:00
.gitattributes Add .gitattributes 2020-07-30 10:51:21 -06:00
.gitignore ignore singularity container files in the entire repo 2020-04-01 20:08:00 -04:00
LICENSE LICENSE: update address of Free Software Foundation 2017-07-21 17:13:28 -06:00
README update list of main folders and descriptions 2020-09-19 02:53:36 -04: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 files
doc                        documentation
examples                   simple test problems
fortran                    Fortran wrapper for LAMMPS
lib                        additional provided or external libraries
potentials                 interatomic potential files
python                     Python wrappers for LAMMPS
src                        source files
tools                      pre- and post-processing tools

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

https://lammps.sandia.gov/doc/Manual.html         LAMMPS user manual
https://lammps.sandia.gov/doc/Intro.html          hi-level introduction
https://lammps.sandia.gov/doc/Build.html          how to build LAMMPS
https://lammps.sandia.gov/doc/Run_head.html       how to run LAMMPS
https://lammps.sandia.gov/doc/Commands_all.html   Table of available commands
https://lammps.sandia.gov/doc/pg_library.html     LAMMPS programmer guide
https://lammps.sandia.gov/doc/Modify.html         how to modify and extend LAMMPS
https://lammps.sandia.gov/doc/pg_developer.html   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