From 2011475077e112e00b7687094095483e6874283a Mon Sep 17 00:00:00 2001 From: sjplimp Date: Fri, 5 Sep 2014 20:21:00 +0000 Subject: [PATCH] git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@12415 f3b2605a-c512-4ea7-a41b-209d697bcdaa --- doc/Section_start.html | 79 ++++++++++++++++++++++++++---------------- doc/Section_start.txt | 77 ++++++++++++++++++++++++---------------- 2 files changed, 97 insertions(+), 59 deletions(-) diff --git a/doc/Section_start.html b/doc/Section_start.html index b75d7cc223..53c16d660d 100644 --- a/doc/Section_start.html +++ b/doc/Section_start.html @@ -30,9 +30,9 @@ experienced users.

2.1 What's in the LAMMPS distribution

-

When you download LAMMPS you will need to unzip and untar the -downloaded file with the following commands, after placing the file in -an appropriate directory. +

When you download a LAMMPS tarball you will need to unzip and untar +the downloaded file with the following commands, after placing the +tarball in an appropriate directory. 

gunzip lammps*.tar.gz 
 tar xvf lammps*.tar 
@@ -51,21 +51,22 @@ sub-directories:
 tools pre- and post-processing tools 
 
 
-
If you download one of the Windows executables from the download page,
-then you get a single file:
+
Note that the download page also has links to download
+Windows exectubles and installers, as well as pre-built executables
+for a few specific Linux distributions.  It also has instructions for
+how to download/install LAMMPS for Macs (via Homebrew), and to
+download and update LAMMPS from SVN and Git repositories, which gives
+you the same files that are in the download tarball.
 

-
lmp_windows.exe 
-

-
Skip to the Running LAMMPS sections for info on how to
-launch these executables on a Windows box.
-

-
The Windows executables for serial or parallel only include certain
-packages and bug-fixes/upgrades listed on this
+
The Windows and Linux executables for serial or parallel only include
+certain packages and bug-fixes/upgrades listed on this
 page up to a certain date, as
-stated on the download page.  If you want something with more packages
-or that is more current, you'll have to download the source tarball
-and build it yourself from source code using Microsoft Visual Studio,
-as described in the next section.
+stated on the download page.  If you want an executable with
+non-included packages or that is more current, then you'll need to
+build LAMMPS yourself, as discussed in the next section.
+

+
Skip to the Running LAMMPS sections for info on how to
+launch a LAMMPS Windows executable on a Windows box.
 

 

 
@@ -84,27 +85,45 @@ as described in the next section.
 
 Read this first: 
 
-
Building LAMMPS can be non-trivial.  You may need to edit a makefile,
-there are compiler options to consider, additional libraries can be
-used (MPI, FFT, JPEG, PNG), LAMMPS packages may be included or
-excluded, some of these packages use auxiliary libraries which need to
-be pre-built, etc.
+
If you want to avoid building LAMMPS, read the preceeding section
+about options available for downloading and installing executables.
+Details are discussed on the download page.
 

-
Please read this section carefully.  If you are not comfortable with
-makefiles, or building codes on a Unix platform, or running an MPI job
-on your machine, please find a local expert to help you.  Many
-compiling, linking, and run problems that users have are often not
-LAMMPS issues - they are peculiar to the user's system, compilers,
-libraries, etc.  Such questions are better answered by a local expert.
+
Building LAMMPS can be simple or not-so-simple.  If MPI is already
+installed on your machine (or you just want to run LAMMPS in serial)
+and you can use one of the provided machine Makefiles and the build
+works on your platform, then it's simple.
+

+
If you want to do one of these:
+

+
+
then building LAMMPS is more complicated.  You may need to find where
+auxiliary libraries exist on your machine or install them if they
+don't.  You may need to build additional libraries that are part of
+the LAMMPS package, before building LAMMPS.  You may need to edit a
+machine Makefile to make it compatible with your system.
+

+
Please read the following sections carefully.  If you are not
+comfortable with makefiles, or building codes on a Unix platform, or
+running an MPI job on your machine, please find a local expert to help
+you.  Many compilation, linking, and run problems that users have are
+often not really LAMMPS issues - they are peculiar to the user's
+system, compilers, libraries, etc.  Such questions are better answered
+by a local expert.
 

 
If you have a build problem that you are convinced is a LAMMPS issue
 (e.g. the compiler complains about a line of LAMMPS source code), then
-please post a question to the LAMMPS mail
+please post the issue to the LAMMPS mail
 list.
 

 
If you succeed in building LAMMPS on a new kind of machine, for which
-there isn't a similar Makefile for in the src/MAKE directory, send it
-to the developers and we can include it in the LAMMPS distribution.
+there isn't a similar machine Makefile included in the src/MAKE
+directory, then send it to the developers and we can include it in the
+LAMMPS distribution.
 

 

 
diff --git a/doc/Section_start.txt b/doc/Section_start.txt
index 509a031cea..0ead566c7b 100644
--- a/doc/Section_start.txt
+++ b/doc/Section_start.txt
@@ -26,9 +26,9 @@ experienced users.
 
 2.1 What's in the LAMMPS distribution :h4,link(start_1)
 
-When you download LAMMPS you will need to unzip and untar the
-downloaded file with the following commands, after placing the file in
-an appropriate directory.
+When you download a LAMMPS tarball you will need to unzip and untar
+the downloaded file with the following commands, after placing the
+tarball in an appropriate directory.
 
 gunzip lammps*.tar.gz 
 tar xvf lammps*.tar :pre
@@ -45,21 +45,22 @@ potentials: embedded atom method (EAM) potential files
 src: source files
 tools: pre- and post-processing tools :tb(s=:)
 
-If you download one of the Windows executables from the download page,
-then you get a single file:
+Note that the "download page"_download also has links to download
+Windows exectubles and installers, as well as pre-built executables
+for a few specific Linux distributions.  It also has instructions for
+how to download/install LAMMPS for Macs (via Homebrew), and to
+download and update LAMMPS from SVN and Git repositories, which gives
+you the same files that are in the download tarball.
 
-lmp_windows.exe :pre
+The Windows and Linux executables for serial or parallel only include
+certain packages and bug-fixes/upgrades listed on "this
+page"_http://lammps.sandia.gov/bug.html up to a certain date, as
+stated on the download page.  If you want an executable with
+non-included packages or that is more current, then you'll need to
+build LAMMPS yourself, as discussed in the next section.
 
 Skip to the "Running LAMMPS"_#start_6 sections for info on how to
-launch these executables on a Windows box.
-
-The Windows executables for serial or parallel only include certain
-packages and bug-fixes/upgrades listed on "this
-page"_http://lammps.sandia.gov/bug.html up to a certain date, as
-stated on the download page.  If you want something with more packages
-or that is more current, you'll have to download the source tarball
-and build it yourself from source code using Microsoft Visual Studio,
-as described in the next section.
+launch a LAMMPS Windows executable on a Windows box.
 
 :line
 
@@ -78,27 +79,45 @@ This section has the following sub-sections:
 
 [{Read this first:}] :link(start_2_1)
 
-Building LAMMPS can be non-trivial.  You may need to edit a makefile,
-there are compiler options to consider, additional libraries can be
-used (MPI, FFT, JPEG, PNG), LAMMPS packages may be included or
-excluded, some of these packages use auxiliary libraries which need to
-be pre-built, etc.
+If you want to avoid building LAMMPS, read the preceeding section
+about options available for downloading and installing executables.
+Details are discussed on the "download"_download page.
 
-Please read this section carefully.  If you are not comfortable with
-makefiles, or building codes on a Unix platform, or running an MPI job
-on your machine, please find a local expert to help you.  Many
-compiling, linking, and run problems that users have are often not
-LAMMPS issues - they are peculiar to the user's system, compilers,
-libraries, etc.  Such questions are better answered by a local expert.
+Building LAMMPS can be simple or not-so-simple.  If MPI is already
+installed on your machine (or you just want to run LAMMPS in serial)
+and you can use one of the provided machine Makefiles and the build
+works on your platform, then it's simple.
+
+If you want to do one of these:
+
+use optional LAMMPS features that require additional libraries
+use optional packages that require additional libraries
+use optional accelerator packages that require special compiler/linker settings
+run on a specialized platform like a supercomputer that has its own compilers, settings, or other libs to use :ul
+
+then building LAMMPS is more complicated.  You may need to find where
+auxiliary libraries exist on your machine or install them if they
+don't.  You may need to build additional libraries that are part of
+the LAMMPS package, before building LAMMPS.  You may need to edit a
+machine Makefile to make it compatible with your system.
+
+Please read the following sections carefully.  If you are not
+comfortable with makefiles, or building codes on a Unix platform, or
+running an MPI job on your machine, please find a local expert to help
+you.  Many compilation, linking, and run problems that users have are
+often not really LAMMPS issues - they are peculiar to the user's
+system, compilers, libraries, etc.  Such questions are better answered
+by a local expert.
 
 If you have a build problem that you are convinced is a LAMMPS issue
 (e.g. the compiler complains about a line of LAMMPS source code), then
-please post a question to the "LAMMPS mail
+please post the issue to the "LAMMPS mail
 list"_http://lammps.sandia.gov/mail.html.
 
 If you succeed in building LAMMPS on a new kind of machine, for which
-there isn't a similar Makefile for in the src/MAKE directory, send it
-to the developers and we can include it in the LAMMPS distribution.
+there isn't a similar machine Makefile included in the src/MAKE
+directory, then send it to the developers and we can include it in the
+LAMMPS distribution.
 
 :line