changeset 222:9a17acd9c121

sphinx docs: added notes about setting up the REFPROP gas model.
author Peter Blyton <p.blyton@uq.edu.au>
date Wed, 23 May 2012 09:23:15 +1000
parents 40720666cdf7
children c40336b84d19
files doc/sphinx/eilmer3.rst doc/sphinx/getting-started.rst
diffstat 2 files changed, 11 insertions(+), 8 deletions(-) [+]
line wrap: on
line diff
--- a/doc/sphinx/eilmer3.rst	Tue May 22 23:03:16 2012 +1000
+++ b/doc/sphinx/eilmer3.rst	Wed May 23 09:23:15 2012 +1000
@@ -21,18 +21,20 @@
   $ make clean
 
 You may need to add the installation directory to your system's 
-search path and to Lua's search path.
-On a recent Linux system, this could be done by adding the lines::
+search path to run Eilmer3.
+On a recent Linux system, this could be done by adding the line::
 
   $ export PATH=${PATH}:${HOME}/e3bin
+
+to the ``.bash_profile`` or ``.bashrc`` file in your home directory.
+
+To access the Lua gas module from within the user-defined (Lua) functions,
+or to use the REFPROP gas model, the following lines should also be added
+to your bash configuration::
+
   $ export LUA_PATH=${HOME}/e3bin/?.lua
   $ export LUA_CPATH=${HOME}/e3bin/?.so
-
-to the ``.bash_profile`` or ``.bashrc`` file in your home directory.
-Note that it is not necessary to have the ``LUA_CPATH`` variable set 
-unless you want to access the Lua gas module from within 
-the user-defined (Lua) functions.
-You don't need it to run Eilmer3 otherwise.
+  $ export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:${HOME}/e3bin
 
 .. _label-openmpi-fedora:
 
--- a/doc/sphinx/getting-started.rst	Tue May 22 23:03:16 2012 +1000
+++ b/doc/sphinx/getting-started.rst	Wed May 23 09:23:15 2012 +1000
@@ -150,6 +150,7 @@
   $ hg clone ssh://cfcfd3@triton/cfcfd3-hg cfcfd3
   $ cd cfcfd3/extern/
   $ hg clone ssh://cfcfd3@triton/cea2-hg cea2
+  $ hg clone ssh://geothermal@triton/refprop-hg refprop