Merge pull request #1025 from lammps/doc-reorg-speed-packages (8c0955aa) · Commits · 郑智淋 / lammps

doc/src/Errors_messages.txt

+3 −3

Original line number	Diff line number	Diff line
		@@ -21,9 +21,9 @@ means that line #78 in the file src/velocity.cpp generated the error.
		Looking in the source code may help you figure out what went wrong.

		Note that error messages from "user-contributed
		packages"_Section_package.html#table_user 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.
		packages"_Packages_user.html 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.

		Doc page with "WARNING messages"_Errors_warnings.html

doc/src/Errors_warnings.txt

+3 −3

Original line number	Diff line number	Diff line
		@@ -21,9 +21,9 @@ means that line #187 in the file src/domain.cpp generated the error.
		Looking in the source code may help you figure out what went wrong.

		Note that warning messages from "user-contributed
		packages"_Section_start.html#table_user are not listed here. If such
		a warning occurs and is not self-explanatory, you'll need to look in
		the source code or contact the author of the package.
		packages"_Packages_user.html are not listed here. If such a warning
		occurs and is not self-explanatory, you'll need to look in the source
		code or contact the author of the package.

		Doc page with "ERROR messages"_Errors_messages.html

doc/src/Examples.txt

+1 −1

Original line number	Diff line number	Diff line
		@@ -143,5 +143,5 @@ The USER directory has a large number of sub-directories which
		correspond by name to a USER package. They contain scripts that
		illustrate how to use the command(s) provided in that package. Many
		of the sub-directories have their own README files which give further
		instructions. See the "Section 4"_Section_packages.html doc
		instructions. See the "Packages_details"_Packages_details.html doc
		page for more info on specific USER packages.

doc/src/Manual.txt

+4 −25

Original line number	Diff line number	Diff line
		@@ -111,11 +111,10 @@ it gives quick access to documentation for all LAMMPS commands.
		Section_intro
		Section_start
		Section_commands
		Section_packages
		Section_accelerate
		Packages
		Speed
		Section_howto
		Examples
		Section_perf
		Tools
		Modify
		Python
		@@ -167,19 +166,8 @@ END_RST -->
		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
		"Packages"_Section_packages.html :l
		4.1 "Standard packages"_pkg_1 :ulb,b
		4.2 "User packages"_pkg_2 :ule,b
		"Accelerating LAMMPS performance"_Section_accelerate.html :l
		5.1 "Measuring performance"_acc_1 :ulb,b
		5.2 "Algorithms and code options to boost performace"_acc_2 :b
		5.3 "Accelerator packages with optimized styles"_acc_3 :b
		5.3.1 "GPU package"_accelerate_gpu.html :b
		5.3.2 "USER-INTEL package"_accelerate_intel.html :b
		5.3.3 "KOKKOS package"_accelerate_kokkos.html :b
		5.3.4 "USER-OMP package"_accelerate_omp.html :b
		5.3.5 "OPT package"_accelerate_opt.html :b
		5.4 "Comparison of various accelerator packages"_acc_4 :ule,b
		"Optional packages"_Packages.html :l
		"Accelerate performance"_Speed.html :l
		"How-to discussions"_Section_howto.html :l
		6.1 "Restarting a simulation"_howto_1 :ulb,b
		6.2 "2d simulations"_howto_2 :b
		@@ -209,7 +197,6 @@ END_RST -->
		6.26 "Adiabatic core/shell model"_howto_26 :b
		6.27 "Drude induced dipoles"_howto_27 :ule,b
		"Example scripts"_Examples.html :l
		"Performance & scalability"_Section_perf.html :l
		"Auxiliary tools"_Tools.html :l
		"Modify & extend LAMMPS"_Modify.html :l
		"Use Python with LAMMPS"_Python.html :l
		@@ -240,14 +227,6 @@ END_RST -->
		:link(cmd_4,Section_commands.html#cmd_4)
		:link(cmd_5,Section_commands.html#cmd_5)

		:link(pkg_1,Section_packages.html#pkg_1)
		:link(pkg_2,Section_packages.html#pkg_2)

		:link(acc_1,Section_accelerate.html#acc_1)
		:link(acc_2,Section_accelerate.html#acc_2)
		:link(acc_3,Section_accelerate.html#acc_3)
		:link(acc_4,Section_accelerate.html#acc_4)

		:link(howto_1,Section_howto.html#howto_1)
		:link(howto_2,Section_howto.html#howto_2)
		:link(howto_3,Section_howto.html#howto_3)

doc/src/Packages.txt

0 → 100644

+39 −0

Original line number	Diff line number	Diff line
		"Previous Section"_Section_commands.html - "LAMMPS WWW Site"_lws -
		"LAMMPS Documentation"_ld - "LAMMPS Commands"_lc - "Next
		Section"_Speed.html :c

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

		:line

		Optional packages :h2

		This section gives an overview of the optional packages that extend
		LAMMPS functionality. Packages are groups of files that enable a
		specific set of features. For example, force fields for molecular
		systems or rigid-body constraint are in packages. You can see the
		list of all packages and "make" commands to manage them by typing
		"make package" from within the src directory of the LAMMPS
		distribution. "Section 2.3"_Section_start.html#start_3 gives general
		info on how to install and un-install packages as part of the LAMMPS
		build process.

		<!-- RST

		.. toctree::

		Packages_standard
		Packages_user
		Packages_details

		END_RST -->

		<!-- HTML_ONLY -->

		"Standard packages"_Packages_standard.html
		"User packages"_Packages_user.html
		"Details on each package"_Packages_details.html :ul

		<!-- END_HTML_ONLY -->

Admin message