From bdbaacd8fb3f8f3aa5e7988031e532ae7313465b Mon Sep 17 00:00:00 2001
From: sjplimp <sjplimp@f3b2605a-c512-4ea7-a41b-209d697bcdaa>
Date: Tue, 14 Aug 2012 23:16:29 +0000
Subject: [PATCH] git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@8665
 f3b2605a-c512-4ea7-a41b-209d697bcdaa

---
 doc/Section_python.html | 29 +++++++++++++++++++----------
 doc/Section_python.txt  | 29 +++++++++++++++++++----------
 doc/Section_start.html  |  6 ++++--
 doc/Section_start.txt   |  6 ++++--
 4 files changed, 46 insertions(+), 24 deletions(-)

diff --git a/doc/Section_python.html b/doc/Section_python.html
index ad690d8e09..46c4ab9783 100644
--- a/doc/Section_python.html
+++ b/doc/Section_python.html
@@ -104,7 +104,7 @@ system.
 
 <A NAME = "py_2"></A><H4>11.2 Installing the Python wrapper into Python 
 </H4>
-<P>For Python to invoke LAMMPS, there are 2 files it needs to have:
+<P>For Python to invoke LAMMPS, there are 2 files it needs to know about:
 </P>
 <UL><LI>python/lammps.py
 <LI>src/liblammps.so 
@@ -133,19 +133,28 @@ python/lammps.py file.
 </P>
 <PRE>% python install.py <B>libdir</B> <B>pydir</B> 
 </PRE>
-<P>The optional libdir is where to copy the LAMMPS shared library to;
-the default is /usr/local/lib.  The optional pydir is where to copy
-the lammps.py file to; the default is the site-packages directory
-of the Python running the install script.
+<P>The optional libdir is where to copy the LAMMPS shared library to; the
+default is /usr/local/lib.  The optional pydir is where to copy the
+lammps.py file to; the default is the site-packages directory of the
+version of Python that is running the install script.
 </P>
-<P>Prefix the python command with "sudo" if it does not allow you to copy
-files into system directories.  If you do this, make sure that the
-Python that root runs is the same as the Python you run.  E.g. you may
-need to do something like
+<P>Note that libdir must be a location that is in your default
+LD_LIBRARY_PATH, like /usr/local/lib or /usr/lib.  And pydir must be a
+location that Python looks in by default for imported modules, like
+its site-packages dir.  If you want to copy these files to
+non-standard locations, such as within your own user space, you will
+need to set your PYTHONPATH and LD_LIBRARY_PATH environment variables
+accordingly, as above.
+</P>
+<P>If the instally.py script does not allow you to copy files into system
+directories, prefix the python command with "sudo".  If you do this,
+make sure that the Python that root runs is the same as the Python you
+run.  E.g. you may need to do something like
 </P>
 <PRE>% sudo /usr/local/bin/python install.py <B>libdir</B> <B>pydir</B> 
 </PRE>
-<P>You can also invoke install.py from the src directory as
+<P>You can also invoke install.py from the make command in the src
+directory as
 </P>
 <PRE>% make install-python 
 </PRE>
diff --git a/doc/Section_python.txt b/doc/Section_python.txt
index 26a7bdbab0..3c29fe6fe6 100644
--- a/doc/Section_python.txt
+++ b/doc/Section_python.txt
@@ -100,7 +100,7 @@ system.
 
 11.2 Installing the Python wrapper into Python :link(py_2),h4
 
-For Python to invoke LAMMPS, there are 2 files it needs to have:
+For Python to invoke LAMMPS, there are 2 files it needs to know about:
 
 python/lammps.py
 src/liblammps.so :ul
@@ -129,19 +129,28 @@ You can invoke install.py from the python directory as
 
 % python install.py [libdir] [pydir] :pre
 
-The optional libdir is where to copy the LAMMPS shared library to;
-the default is /usr/local/lib.  The optional pydir is where to copy
-the lammps.py file to; the default is the site-packages directory
-of the Python running the install script.
+The optional libdir is where to copy the LAMMPS shared library to; the
+default is /usr/local/lib.  The optional pydir is where to copy the
+lammps.py file to; the default is the site-packages directory of the
+version of Python that is running the install script.
 
-Prefix the python command with "sudo" if it does not allow you to copy
-files into system directories.  If you do this, make sure that the
-Python that root runs is the same as the Python you run.  E.g. you may
-need to do something like
+Note that libdir must be a location that is in your default
+LD_LIBRARY_PATH, like /usr/local/lib or /usr/lib.  And pydir must be a
+location that Python looks in by default for imported modules, like
+its site-packages dir.  If you want to copy these files to
+non-standard locations, such as within your own user space, you will
+need to set your PYTHONPATH and LD_LIBRARY_PATH environment variables
+accordingly, as above.
+
+If the instally.py script does not allow you to copy files into system
+directories, prefix the python command with "sudo".  If you do this,
+make sure that the Python that root runs is the same as the Python you
+run.  E.g. you may need to do something like
 
 % sudo /usr/local/bin/python install.py [libdir] [pydir] :pre
 
-You can also invoke install.py from the src directory as
+You can also invoke install.py from the make command in the src
+directory as
 
 % make install-python :pre
 
diff --git a/doc/Section_start.html b/doc/Section_start.html
index 3755aaaaf4..e225c3394a 100644
--- a/doc/Section_start.html
+++ b/doc/Section_start.html
@@ -850,9 +850,11 @@ should be the file /usr/local/lib/libmpich.so.
 the environment variable LD_LIBRARY_PATH.  So you may wish to copy the
 file src/liblammps.so or src/liblammps_g++.so (for example) to a place
 the system can find it by default, such as /usr/local/lib, or you may
-wish to add the lammps src directory to LD_LIBRARY_PATH.
+wish to add the lammps src directory to LD_LIBRARY_PATH, so that the
+current version of the shared library is always available to programs
+that use it.
 </P>
-<P>For the csh or tcsh shells, you could add something like this to your
+<P>For the csh or tcsh shells, you would add something like this to your
 ~/.cshrc file:
 </P>
 <PRE>setenv LD_LIBRARY_PATH $<I>LD_LIBRARY_PATH</I>:/home/sjplimp/lammps/src 
diff --git a/doc/Section_start.txt b/doc/Section_start.txt
index 563d765f10..5712e91236 100644
--- a/doc/Section_start.txt
+++ b/doc/Section_start.txt
@@ -844,9 +844,11 @@ The operating system finds shared libraries to load at run-time using
 the environment variable LD_LIBRARY_PATH.  So you may wish to copy the
 file src/liblammps.so or src/liblammps_g++.so (for example) to a place
 the system can find it by default, such as /usr/local/lib, or you may
-wish to add the lammps src directory to LD_LIBRARY_PATH.
+wish to add the lammps src directory to LD_LIBRARY_PATH, so that the
+current version of the shared library is always available to programs
+that use it.
 
-For the csh or tcsh shells, you could add something like this to your
+For the csh or tcsh shells, you would add something like this to your
 ~/.cshrc file:
 
 setenv LD_LIBRARY_PATH ${LD_LIBRARY_PATH}:/home/sjplimp/lammps/src :pre