Go to file
Richard Berger 8b410cf2bd
Add scripts to simplify offline builds of docs and CMake
2021-04-29 13:26:55 -04:00
.github update the GitHub contributing guide to include the MatSci forum in addition to the mailing list. 2021-04-25 07:25:05 -04:00
bench Merge branch 'master' into collected-small-changes 2020-10-14 13:11:30 -04:00
cmake Merge pull request #2737 from ab5424/patch 2021-04-27 22:32:30 -04:00
doc document line length limit in atomfile variable names 2021-04-27 18:43:23 -04:00
examples Merge branch 'clean-master2' of github.com:julient31/lammps into STT2 2021-04-19 17:32:16 -06:00
fortran make f2c_string utility function portable across fortran compilers 2020-10-02 10:36:17 -04:00
lib remove the old versions of the utility function and use the new 2021-04-24 21:33:36 -04:00
potentials pair_pace.cpp: check that units are "metal" 2021-04-09 13:31:40 +02:00
python make installation procedure consistent with install.py 2021-04-13 09:58:19 -04:00
src Add missing code in Kokkos neighborlist to use custom cutoff 2021-04-28 13:54:23 -06:00
tools Add scripts to simplify offline builds of docs and CMake 2021-04-29 13:26:55 -04:00
unittest update unit tests 2021-04-27 18:46:30 -04:00
.gitattributes Add .gitattributes 2020-07-30 10:51:21 -06:00
.gitignore ignore LAMMPS shell history files 2020-10-04 12:27:40 -04:00
LICENSE indicate that we use GPLv2 2021-03-05 14:16:40 -05:00
README update URLs in README file 2020-11-25 16:51:43 -05: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 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/Library.html        LAMMPS library interfaces
https://lammps.sandia.gov/doc/Modify.html         how to modify and extend LAMMPS
https://lammps.sandia.gov/doc/Developer.html      LAMMPS developer info

You can also create these doc pages locally:

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