Unverified Commit ded65712 authored by Axel Kohlmeyer's avatar Axel Kohlmeyer Committed by GitHub
Browse files

Merge pull request #2312 from akohlmey/developer-guide 

Integrate text from developer.tex file to the manual
parents 899144c0 e8cfa185

doc/Makefile

+4 −12
Original line number Diff line number Diff line
@@ -54,7 +54,7 @@ DOXYFILES = $(shell sed -n -e 's/\#.*$$//' -e '/^ *INPUT \+=/,/^[A-Z_]\+ \+ 
help:

	@echo "Please use \`make <target>' where <target> is one of"

	@echo "  html          create HTML doc pages in html dir"

	@echo "  pdf           create Developer.pdf and Manual.pdf in this dir"

	@echo "  pdf           create Manual.pdf in this dir"

	@echo "  fetch         fetch HTML and PDF files from LAMMPS web site"

	@echo "  epub          create ePUB format manual for e-book readers"

	@echo "  mobi          convert ePUB to MOBI format manual for e-book readers (e.g. Kindle)"
@@ -69,7 +69,7 @@ help: 
# ------------------------------------------



clean-all: clean

	rm -rf $(BUILDDIR)/docenv $(MATHJAX) $(BUILDDIR)/LAMMPS.mobi $(BUILDDIR)/LAMMPS.epub $(BUILDDIR)/Manual.pdf $(BUILDDIR)/Developer.pdf

	rm -rf $(BUILDDIR)/docenv $(MATHJAX) $(BUILDDIR)/LAMMPS.mobi $(BUILDDIR)/LAMMPS.epub $(BUILDDIR)/Manual.pdf



clean: clean-spelling

	rm -rf $(BUILDDIR)/html $(BUILDDIR)/epub $(BUILDDIR)/latex $(BUILDDIR)/doctrees $(BUILDDIR)/doxygen/xml $(BUILDDIR)/doxygen-warn.log $(BUILDDIR)/doxygen/Doxyfile $(SPHINXCONFIG)/conf.py
@@ -139,13 +139,6 @@ mobi: epub 
pdf: xmlgen $(VENV) $(SPHINXCONFIG)/conf.py $(ANCHORCHECK)

	@$(MAKE) $(MFLAGS) -C graphviz all

	@if [ "$(HAS_PDFLATEX)" == "NO" ] ; then echo "PDFLaTeX was not found! Please check README.md for further instructions" 1>&2; exit 1; fi

	@(\

		cd src/Developer; \

		pdflatex developer; \

		pdflatex developer; \

		mv developer.pdf ../../Developer.pdf; \

		cd ../../; \

	)

	@(\

		. $(VENV)/bin/activate ; env PYTHONWARNINGS= \

		sphinx-build $(SPHINXEXTRA) -b latex -c $(SPHINXCONFIG) -d $(BUILDDIR)/doctrees $(RSTDIR) latex ;\
@@ -175,12 +168,11 @@ pdf: xmlgen $(VENV) $(SPHINXCONFIG)/conf.py $(ANCHORCHECK) 
	@rm -rf latex/USER

	@cp -r src/PDF latex/PDF

	@rm -rf latex/PDF/.[sg]*

	@echo "Build finished. Manual.pdf and Developer.pdf are in this directory."

	@echo "Build finished. Manual.pdf is in this directory."



fetch:

	@rm -rf html_www Manual_www.pdf Developer_www.pdf

	@rm -rf html_www Manual_www.pdf

	@curl -s -o Manual_www.pdf http://lammps.sandia.gov/doc/Manual.pdf

	@curl -s -o Developer_www.pdf http://lammps.sandia.gov/doc/Developer.pdf

	@curl -s -o lammps-doc.tar.gz http://lammps.sandia.gov/tars/lammps-doc.tar.gz

	@tar xzf lammps-doc.tar.gz

	@rm -f lammps-doc.tar.gz

doc/src/Build_basics.rst

+1 −1
Original line number Diff line number Diff line
@@ -471,7 +471,7 @@ LAMMPS source distribution. 
.. code-block:: bash



  make html          # create HTML doc pages in html directory

  make pdf           # create Developer.pdf and Manual.pdf in this directory

  make pdf           # create Manual.pdf in this directory

  make fetch         # fetch HTML and PDF files from LAMMPS web site

  make clean         # remove all intermediate files

  make clean-all     # reset the entire doc build environment

doc/src/Developer/.gitignore

deleted100644 → 0
+0 −3
Original line number Diff line number Diff line 
/developer.aux

/developer.log

/developer.toc

doc/src/Developer/classes.fig

deleted100644 → 0
+0 −198
Original line number Diff line number Diff line 
#FIG 3.2  Produced by xfig version 3.2.5a

Portrait

Center

Inches

Letter  

100.00

Single

-2

1200 2

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 2232 1170 3540 1170 3540 1505 2232 1505 2232 1170

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 2220 1830 3015 1830 3015 2219 2220 2219 2220 1830

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 2226 3285 3300 3285 3300 3665 2226 3665 2226 3285

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 2223 5190 3225 5190 3225 5525 2223 5525 2223 5190

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 2232 7125 3090 7125 3090 7478 2232 7478 2232 7125

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 2226 10230 3300 10230 3300 10565 2226 10565 2226 10230

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 4026 10305 4980 10305 4980 10592 4026 10592 4026 10305

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 4029 9900 5205 9900 5205 10250 4029 10250 4029 9900

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 4038 9315 5370 9315 5370 9659 4038 9659 4038 9315

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 4023 8955 4530 8955 4530 9278 4023 9278 4023 8955

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 4029 8475 5190 8475 5190 8762 4029 8762 4029 8475

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 4008 8115 5430 8115 5430 8408 4008 8408 4008 8115

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 4026 7425 4995 7425 4995 7712 4026 7712 4026 7425

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 4035 6720 4650 6720 4650 7025 4035 7025 4035 6720

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 4044 7080 4830 7080 4830 7358 4044 7358 4044 7080

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 4032 6105 5205 6105 5205 6419 4032 6419 4032 6105

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 4026 5715 5115 5715 5115 6062 4026 6062 4026 5715

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 4023 3585 4605 3585 4605 3872 4023 3872 4023 3585

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 3954 1680 5175 1680 5175 1997 3954 1997 3954 1680

2 1 0 2 0 7 50 -1 -1 0.000 0 0 -1 1 0 2

	1 1 2.00 120.00 240.00

	 1620 5235 2100 615

2 1 0 2 0 7 50 -1 -1 0.000 0 0 -1 1 0 2

	1 1 2.00 120.00 240.00

	 1605 5445 2070 10695

2 1 0 2 0 7 50 -1 -1 0.000 0 0 -1 1 0 2

	1 1 2.00 120.00 240.00

	 3120 1935 3855 1800

2 1 0 2 0 7 50 -1 -1 0.000 0 0 -1 1 0 2

	1 1 2.00 120.00 240.00

	 3150 2115 3765 2250

2 1 0 2 0 7 50 -1 -1 0.000 0 0 -1 1 0 2

	1 1 2.00 120.00 240.00

	 3135 7230 3945 6840

2 1 0 2 0 7 50 -1 -1 0.000 0 0 -1 1 0 2

	1 1 2.00 120.00 240.00

	 3150 7335 3945 8610

2 1 0 2 0 7 50 -1 -1 0.000 0 0 -1 1 0 2

	1 1 2.00 120.00 240.00

	 5265 8610 6195 8400

2 1 0 2 0 7 50 -1 -1 0.000 0 0 -1 1 0 2

	1 1 2.00 120.00 240.00

	 5280 8655 6180 8820

2 1 0 2 0 7 50 -1 -1 0.000 0 0 -1 1 0 2

	1 1 2.00 120.00 240.00

	 3345 10290 3930 10020

2 1 0 2 0 7 50 -1 -1 0.000 0 0 -1 1 0 2

	1 1 2.00 120.00 240.00

	 3360 10395 3930 10425

2 1 0 2 0 7 50 -1 -1 0.000 0 0 -1 1 0 2

	1 1 2.00 120.00 240.00

	 3360 10455 3930 10755

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 2193 360 3435 360 3435 647 2193 647 2193 360

2 1 0 2 0 7 50 -1 -1 0.000 0 0 -1 1 0 2

	1 1 2.00 120.00 240.00

	 3398 3472 3923 3307

2 1 0 2 0 7 50 -1 -1 0.000 0 0 -1 1 0 2

	1 1 2.00 120.00 240.00

	 3413 3601 3923 3721

2 1 0 2 0 7 50 -1 -1 0.000 0 0 -1 1 0 2

	1 1 2.00 120.00 240.00

	 3285 2806 3870 2802

2 1 0 2 0 7 50 -1 -1 0.000 0 0 -1 1 0 2

	1 1 2.00 120.00 240.00

	 3315 5372 3900 5368

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 6354 2280 7470 2280 7470 2585 6354 2585 6354 2280

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 6348 1875 7320 1875 7320 2222 6348 2222 6348 1875

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 3954 2070 5505 2070 5505 2372 3954 2372 3954 2070

2 1 0 2 0 7 50 -1 -1 0.000 0 0 -1 1 0 2

	1 1 2.00 120.00 240.00

	 5634 2137 6230 2045

2 1 0 2 0 7 50 -1 -1 0.000 0 0 -1 1 0 2

	1 1 2.00 120.00 240.00

	 5670 2310 6265 2418

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 3900 2640 5400 2640 5400 2975 3900 2975 3900 2640

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 4038 3165 5385 3165 5385 3497 4038 3497 4038 3165

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 4245 4110 5730 4110 5730 4499 4245 4499 4245 4110

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 4233 4545 6390 4545 6390 4862 4233 4862 4233 4545

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 4026 5190 5385 5190 5385 5525 4026 5525 4026 5190

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 4038 7755 5310 7755 5310 8075 4038 8075 4038 7755

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 6270 8250 7365 8250 7365 8610 6270 8610 6270 8250

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 6273 8655 7380 8655 7380 8978 6273 8978 6273 8655

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 4041 10620 5985 10620 5985 10943 4041 10943 4041 10620

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 2217 10830 3135 10830 3135 11156 2217 11156 2217 10830

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 2229 9780 3240 9780 3240 10118 2229 10118 2229 9780

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 2214 9015 3285 9015 3285 9362 2214 9362 2214 9015

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 2208 5850 3420 5850 3420 6209 2208 6209 2208 5850

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 2217 4275 3615 4275 3615 4634 2217 4634 2217 4275

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 2235 2655 3150 2655 3150 3000 2235 3000 2235 2655

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 60 5115 1500 5115 1500 5610 60 5610 60 5115

2 1 0 2 0 7 50 -1 -1 0.000 0 0 -1 1 0 2

	1 1 2.00 120.00 240.00

	 3486 6018 4011 5853

2 1 0 2 0 7 50 -1 -1 0.000 0 0 -1 1 0 2

	1 1 2.00 120.00 240.00

	 3486 6129 3996 6249

2 1 0 2 0 7 50 -1 -1 0.000 0 0 -1 1 0 2

	1 1 2.00 120.00 240.00

	 3361 9291 3991 9531

2 1 0 2 0 7 50 -1 -1 0.000 0 0 -1 1 0 2

	1 1 2.00 120.00 240.00

	 3345 9129 4005 9099

2 1 0 2 0 7 50 -1 -1 0.000 0 0 -1 1 0 2

	1 1 2.00 120.00 240.00

	 3691 4412 4216 4277

2 1 0 2 0 7 50 -1 -1 0.000 0 0 -1 1 0 2

	1 1 2.00 120.00 240.00

	 3695 4561 4175 4711

2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5

	 2220 735 3129 735 3129 1043 2220 1043 2220 735

4 0 1 50 -1 18 18 0.0000 4 225 1275 2265 1455 Universe\001

4 0 1 50 -1 18 18 0.0000 4 285 735 2265 2175 Input\001

4 0 1 50 -1 18 18 0.0000 4 225 780 2265 2925 Atom\001

4 0 1 50 -1 18 18 0.0000 4 285 1020 2265 3600 Update\001

4 0 1 50 -1 18 18 0.0000 4 285 1320 2265 4575 Neighbor\001

4 0 1 50 -1 18 18 0.0000 4 225 945 2265 5475 Comm\001

4 0 1 50 -1 18 18 0.0000 4 225 1110 2265 6150 Domain\001

4 0 1 50 -1 18 18 0.0000 4 225 810 2265 7425 Force\001

4 0 1 50 -1 18 18 0.0000 4 285 975 2265 9300 Modify\001

4 0 1 50 -1 18 18 0.0000 4 285 900 2265 10050 Group\001

4 0 1 50 -1 18 18 0.0000 4 285 990 2265 10500 Output\001

4 0 1 50 -1 18 18 0.0000 4 225 825 2265 11100 Timer\001

4 0 0 50 -1 18 18 0.0000 4 225 1170 3990 1950 Variable\001

4 0 4 50 -1 18 18 0.0000 4 225 1470 3990 2325 Command\001

4 0 4 50 -1 18 18 0.0000 4 285 1275 4065 3450 Integrate\001

4 0 4 50 -1 18 18 0.0000 4 225 525 4065 3825 Min\001

4 0 0 50 -1 18 18 0.0000 4 285 1230 4065 5475 Irregular\001

4 0 4 50 -1 18 18 0.0000 4 285 1020 4065 6000 Region\001

4 0 0 50 -1 18 18 0.0000 4 225 975 4065 6375 Lattice\001

4 0 4 50 -1 18 18 0.0000 4 225 435 4065 9225 Fix\001

4 0 4 50 -1 18 18 0.0000 4 285 1305 4065 9600 Compute\001

4 0 4 50 -1 18 18 0.0000 4 225 570 4065 6975 Pair\001

4 0 4 50 -1 18 18 0.0000 4 285 840 4065 7665 Angle\001

4 0 4 50 -1 18 18 0.0000 4 225 1215 4065 8010 Dihedral\001

4 0 4 50 -1 18 18 0.0000 4 285 1305 4065 8355 Improper\001

4 0 4 50 -1 18 18 0.0000 4 285 1095 4065 8700 KSpace\001

4 0 4 50 -1 18 18 0.0000 4 285 855 4065 10545 Dump\001

4 0 0 50 -1 18 18 0.0000 4 225 1815 4065 10890 WriteRestart\001

4 0 0 50 -1 18 18 0.0000 4 225 930 6315 8550 FFT3D\001

4 0 0 50 -1 18 18 0.0000 4 285 1005 6315 8925 Remap\001

4 0 0 50 -1 18 18 0.0000 4 225 885 6390 2175 Finish\001

4 0 0 50 -1 18 18 0.0000 4 285 1050 6390 2550 Special\001

4 0 4 50 -1 18 18 0.0000 4 225 1305 3990 2925 AtomVec\001

4 0 4 50 -1 18 18 0.0000 4 225 765 4065 7320 Bond\001

4 0 0 50 -1 18 18 0.0000 4 225 1095 4065 10200 Thermo\001

4 0 0 50 -1 18 18 0.0000 4 285 1380 4305 4425 NeighList\001

4 0 0 50 -1 18 18 0.0000 4 285 2025 4305 4800 NeighRequest\001

4 0 1 50 -1 18 18 0.0000 4 285 1155 2250 600 Memory\001

4 0 0 50 -1 18 18 0.0000 4 225 1305 120 5475 LAMMPS\001

4 0 1 50 -1 18 18 0.0000 4 225 735 2265 1005 Error\001

doc/src/Developer/classes.pdf

deleted100644 → 0
−9 KiB

File deleted.

View file

CRA Git | Maintained and supported by SUSTech CRA and CCSE