From f1b850e1e1b95f44c4e2e2c0bb7aa7afdf02f9a2 Mon Sep 17 00:00:00 2001 From: sjplimp Date: Thu, 8 Jan 2015 19:17:29 +0000 Subject: [PATCH] git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@12898 f3b2605a-c512-4ea7-a41b-209d697bcdaa --- doc/Section_start.html | 35 +++++++++++++++++++++++------------ doc/Section_start.txt | 35 +++++++++++++++++++++++------------ 2 files changed, 46 insertions(+), 24 deletions(-) diff --git a/doc/Section_start.html b/doc/Section_start.html index 673f956fc2..c7645d84f8 100644 --- a/doc/Section_start.html +++ b/doc/Section_start.html @@ -912,6 +912,13 @@ can be used to automate various steps of the build process. It is particularly useful for working with the accelerator packages, as well as other packages which require auxiliary libraries to be built.

+

The goal of the Make.py tool is to allow any complex multi-step LAMMPS +build to be performed as a single Make.py command. And you can +archive the commands, so they can be re-invoked later via the -r +(redo) switch. If you find some LAMMPS build procedure that can't be +done in a single Make.py command, let the developers know, and we'll +see if we can augment the tool. +

You can run Make.py from the src directory by typing either: 

Make.py -h
@@ -927,13 +934,13 @@ Python.  And you may need to insure the script is executable:
 

 

-
-
-
-
-
-
-
+
+
+
+
+
+

 
Install/uninstall packages Make.py -p no-lib kokkos omp intel
Build specific auxiliary libs Make.py lib-atc lib-meam
Build libs for all installed packages Make.py -p cuda gpu -gpu mode=double arch=31 lib-all
Create a Makefile from scratch with compiler and MPI settings Make.py -m none -cc g++ -mpi mpich file
Augment Makefile.serial with settings for installed packages Make.py -p intel -intel cpu -m serial file
Add JPG and FFTW support to Makefile.mpi Make.py -m mpi -jpg -fft fftw file
Build LAMMPS with a parallel make using Makefile.mpi Make.py -j 16 -m mpi exe
Build LAMMPS and libs it needs using Makefile.serial with accelerator settings Make.py -p gpu intel -intel cpu lib-all file serial 
+
Build specific auxiliary libs Make.py -a lib-atc lib-meam
Build libs for all installed packages Make.py -p cuda gpu -gpu mode=double arch=31 -a lib-all
Create a Makefile from scratch with compiler and MPI settings Make.py -m none -cc g++ -mpi mpich -a file
Augment Makefile.serial with settings for installed packages Make.py -p intel -intel cpu -m serial -a file
Add JPG and FFTW support to Makefile.mpi Make.py -m mpi -jpg -fft fftw -a file
Build LAMMPS with a parallel make using Makefile.mpi Make.py -j 16 -m mpi -a exe
Build LAMMPS and libs it needs using Makefile.serial with accelerator settings Make.py -p gpu intel -intel cpu -a lib-all file serial 
 

 
 
The bench and examples directories give Make.py commands that can be
@@ -954,11 +961,15 @@ the "-h" switch.
 

 
E.g. typing "Make.py -h" gives
 

-
Syntax: Make.py switch args ... action1 action2 ...
-  actions:
-    lib-all, lib-dir, clean, file, exe or machine
-    zero or more actions, in any order (machine must be last)
-  switches:
+
Syntax: Make.py switch args ...
+  switches can be listed in any order
+  help switch:
+    -h prints help and syntax for all other specified switches
+  switch for actions:
+    -a lib-all, lib-dir, clean, file, exe or machine
+    list one or more actions, in any order
+    machine is a Makefile.machine suffix, must be last if used
+  one-letter switches:
     -d (dir), -j (jmake), -m (makefile), -o (output),
     -p (packages), -r (redo), -s (settings), -v (verbose)
   switches for libs:
diff --git a/doc/Section_start.txt b/doc/Section_start.txt
index 0655247c5c..0b534d6bc9 100644
--- a/doc/Section_start.txt
+++ b/doc/Section_start.txt
@@ -906,6 +906,13 @@ can be used to automate various steps of the build process.  It is
 particularly useful for working with the accelerator packages, as well
 as other packages which require auxiliary libraries to be built.
 
+The goal of the Make.py tool is to allow any complex multi-step LAMMPS
+build to be performed as a single Make.py command.  And you can
+archive the commands, so they can be re-invoked later via the -r
+(redo) switch.  If you find some LAMMPS build procedure that can't be
+done in a single Make.py command, let the developers know, and we'll
+see if we can augment the tool.
+
 You can run Make.py from the src directory by typing either:
 
 Make.py -h
@@ -920,13 +927,13 @@ chmod +x Make.py :pre
 Here are examples of build tasks you can perform with Make.py:
 
 Install/uninstall packages: Make.py -p no-lib kokkos omp intel
-Build specific auxiliary libs: Make.py lib-atc lib-meam
-Build libs for all installed packages: Make.py -p cuda gpu -gpu mode=double arch=31 lib-all
-Create a Makefile from scratch with compiler and MPI settings: Make.py -m none -cc g++ -mpi mpich file
-Augment Makefile.serial with settings for installed packages: Make.py -p intel -intel cpu -m serial file
-Add JPG and FFTW support to Makefile.mpi: Make.py -m mpi -jpg -fft fftw file
-Build LAMMPS with a parallel make using Makefile.mpi: Make.py -j 16 -m mpi exe
-Build LAMMPS and libs it needs using Makefile.serial with accelerator settings: Make.py -p gpu intel -intel cpu lib-all file serial :tb(s=:)
+Build specific auxiliary libs: Make.py -a lib-atc lib-meam
+Build libs for all installed packages: Make.py -p cuda gpu -gpu mode=double arch=31 -a lib-all
+Create a Makefile from scratch with compiler and MPI settings: Make.py -m none -cc g++ -mpi mpich -a file
+Augment Makefile.serial with settings for installed packages: Make.py -p intel -intel cpu -m serial -a file
+Add JPG and FFTW support to Makefile.mpi: Make.py -m mpi -jpg -fft fftw -a file
+Build LAMMPS with a parallel make using Makefile.mpi: Make.py -j 16 -m mpi -a exe
+Build LAMMPS and libs it needs using Makefile.serial with accelerator settings: Make.py -p gpu intel -intel cpu -a lib-all file serial :tb(s=:)
 
 The bench and examples directories give Make.py commands that can be
 used to build LAMMPS with the various packages and options needed to
@@ -946,11 +953,15 @@ the "-h" switch.
 
 E.g. typing "Make.py -h" gives
 
-Syntax: Make.py switch args ... {action1} {action2} ...
-  actions:
-    lib-all, lib-dir, clean, file, exe or machine
-    zero or more actions, in any order (machine must be last)
-  switches:
+Syntax: Make.py switch args ...
+  switches can be listed in any order
+  help switch:
+    -h prints help and syntax for all other specified switches
+  switch for actions:
+    -a lib-all, lib-dir, clean, file, exe or machine
+    list one or more actions, in any order
+    machine is a Makefile.machine suffix, must be last if used
+  one-letter switches:
     -d (dir), -j (jmake), -m (makefile), -o (output),
     -p (packages), -r (redo), -s (settings), -v (verbose)
   switches for libs: