Unverified Commit 5770a59e authored by Steve Plimpton's avatar Steve Plimpton Committed by GitHub
Browse files

Merge pull request #846 from akohlmey/pdf-manual-reorg

Refactor PDF Manual Structure
parents db5a6b27 1a402d40
Loading
Loading
Loading
Loading
+1 −1
Original line number Diff line number Diff line
@@ -21,7 +21,7 @@ HAS_VIRTUALENV = YES
endif

SPHINXEXTRA = -j $(shell $(PYTHON) -c 'import multiprocessing;print(multiprocessing.cpu_count())')
SOURCES=$(filter-out src/lammps_commands.txt src/lammps_tutorials.txt,$(wildcard src/*.txt))
SOURCES=$(filter-out $(wildcard src/lammps_commands*.txt) src/lammps_support.txt src/lammps_tutorials.txt,$(wildcard src/*.txt))
OBJECTS=$(SOURCES:src/%.txt=$(RSTDIR)/%.rst)

.PHONY: help clean-all clean epub html pdf old venv spelling anchor_check
+3 −5
Original line number Diff line number Diff line
@@ -18,12 +18,10 @@

:line

<H1></H1>
LAMMPS Documentation :c,h1
16 Mar 2018 version :c,h2

LAMMPS Documentation :c,h3
16 Mar 2018 version :c,h4

Version info: :h4
Version info: :h3

The LAMMPS "version" is the date when it was released, such as 1 May
2010. LAMMPS is updated continuously.  Whenever we fix a bug or add a
+5 −5
Original line number Diff line number Diff line
@@ -8,7 +8,7 @@ Section"_Section_howto.html :c

:line

5. Accelerating LAMMPS performance :h3
5. Accelerating LAMMPS performance :h2

This section describes various methods for improving LAMMPS
performance for different classes of problems running on different
@@ -41,7 +41,7 @@ compute nodes, on different hardware platforms.
:line
:line

5.1 Measuring performance :h4,link(acc_1)
5.1 Measuring performance :h3,link(acc_1)

Before trying to make your simulation run faster, you should
understand how it currently performs and where the bottlenecks are.
@@ -89,7 +89,7 @@ LAMMPS, to obtain synchronized timings.

:line

5.2 General strategies :h4,link(acc_2)
5.2 General strategies :h3,link(acc_2)

NOTE: this section 5.2 is still a work in progress

@@ -141,7 +141,7 @@ when using a barostat.

:line

5.3 Packages with optimized styles :h4,link(acc_3)
5.3 Packages with optimized styles :h3,link(acc_3)

Accelerated versions of various "pair_style"_pair_style.html,
"fixes"_fix.html, "computes"_compute.html, and other commands have
@@ -325,7 +325,7 @@ restrictions :ul

:line

5.4 Comparison of various accelerator packages :h4,link(acc_4)
5.4 Comparison of various accelerator packages :h3,link(acc_4)

NOTE: this section still needs to be re-worked with additional KOKKOS
and USER-INTEL information.
+11 −11
Original line number Diff line number Diff line
@@ -6,7 +6,7 @@

:line

3. Commands :h3
3. Commands :h2

This section describes how a LAMMPS input script is formatted and the
input script commands used to define a LAMMPS simulation.
@@ -190,7 +190,7 @@ allowed, but that should be sufficient for most use cases.

:line

3.3 Input script structure :h4,link(cmd_3)
3.3 Input script structure :h3,link(cmd_3)

This section describes the structure of a typical LAMMPS input script.
The "examples" directory in the LAMMPS distribution contains many
@@ -414,7 +414,7 @@ Input script control:

:line

3.5 Individual commands :h4,link(cmd_5),link(comm)
3.5 Individual commands :h3,link(cmd_5),link(comm)

This section lists all LAMMPS commands alphabetically, with a separate
listing below of styles within certain commands.  The "previous
@@ -537,7 +537,7 @@ package"_Section_start.html#start_3.

:line

Fix styles :h4
Fix styles :h3

See the "fix"_fix.html command for one-line descriptions of each style
or click on the style itself for a full description.  Some of the
@@ -751,7 +751,7 @@ package"_Section_start.html#start_3.

:line

Compute styles :h4
Compute styles :h3

See the "compute"_compute.html command for one-line descriptions of
each style or click on the style itself for a full description.  Some
@@ -894,7 +894,7 @@ package"_Section_start.html#start_3.

:line

Pair_style potentials :h4
Pair_style potentials :h3

See the "pair_style"_pair_style.html command for an overview of pair
potentials.  Click on the style itself for a full description.  Many
@@ -1110,7 +1110,7 @@ package"_Section_start.html#start_3.

:line

Bond_style potentials :h4
Bond_style potentials :h3

See the "bond_style"_bond_style.html command for an overview of bond
potentials.  Click on the style itself for a full description.  Some
@@ -1144,7 +1144,7 @@ package"_Section_start.html#start_3.

:line

Angle_style potentials :h4
Angle_style potentials :h3

See the "angle_style"_angle_style.html command for an overview of
angle potentials.  Click on the style itself for a full description.
@@ -1180,7 +1180,7 @@ package"_Section_start.html#start_3.

:line

Dihedral_style potentials :h4
Dihedral_style potentials :h3

See the "dihedral_style"_dihedral_style.html command for an overview
of dihedral potentials.  Click on the style itself for a full
@@ -1214,7 +1214,7 @@ package"_Section_start.html#start_3.

:line

Improper_style potentials :h4
Improper_style potentials :h3

See the "improper_style"_improper_style.html command for an overview
of improper potentials.  Click on the style itself for a full
@@ -1243,7 +1243,7 @@ package"_Section_start.html#start_3.

:line

Kspace solvers :h4
Kspace solvers :h3

See the "kspace_style"_kspace_style.html command for an overview of
Kspace solvers.  Click on the style itself for a full description.
+4 −4
Original line number Diff line number Diff line
@@ -8,7 +8,7 @@ Section"_Section_history.html :c

:line

12. Errors :h3
12. Errors :h2

This section describes the errors you can encounter when using LAMMPS,
either conceptually, or as printed out by the program.
@@ -167,7 +167,7 @@ As a last resort, you can send an email directly to the

:line

12.3 Error & warning messages :h4,link(err_3)
12.3 Error & warning messages :h3,link(err_3)

These are two alphabetic lists of the "ERROR"_#error and
"WARNING"_#warn messages LAMMPS prints out and the reason why.  If the
@@ -186,7 +186,7 @@ packages"_Section_start.html#start_3 are not listed here. If such an
error occurs and is not self-explanatory, you'll need to look in the
source code or contact the author of the package.

Errors: :h4,link(error)
Errors: :h3,link(error)

:dlb

@@ -11037,7 +11037,7 @@ Self-explanatory. :dd

:dle

Warnings: :h4,link(warn)
Warnings: :h3,link(warn)

:dlb

Loading