[Developers] LORENE -- build and doc improvements

Steve White steve.white at aei.mpg.de
Thu Oct 20 08:36:18 CDT 2005


The attached patch improves the LORENE thorn, regarding the build
process and documentation, as mentioned yesterday on the developers list.

Affected are:

CactusExternal/LORENE/LORENE.sh

	* Change "Lorene" to "LORENE" in messages.

	* More helpful error message for when LORENE can't be found

	* Better search path for installation directory

CactusExternal/LORENE/doc/documentation.tex

	* Short description of thorn with reference to the LORENE web site.

Cheers!

-- 
Steve White : Programmer
Max-Planck-Institut für Gravitationsphysik      Albert-Einstein-Institut
Am Mühlenberg 1, D-14476 Golm, Germany                  +49-331-567-7625

? LORENE.diff
Index: LORENE.sh
===================================================================
RCS file: /cactusdevcvs/CactusExternal/LORENE/LORENE.sh,v
retrieving revision 1.5
diff -u -r1.5 LORENE.sh
--- LORENE.sh	27 Aug 2004 03:37:45 -0000	1.5
+++ LORENE.sh	20 Oct 2005 13:29:26 -0000
@@ -45,24 +45,26 @@
 }
 
 
-# Work out Lorene's installation directory
+# Work out LORENE's installation directory
 if [ -z "$LORENE_DIR" ]; then
   echo "BEGIN MESSAGE"
-  echo 'Lorene selected but no LORENE_DIR set.  Checking some places...'
+  echo 'LORENE selected but no LORENE_DIR set.  Checking some places...'
   echo "END MESSAGE"
-  CCTK_Search LORENE_DIR '/usr /usr/local /usr/local/lorene /usr/local/packages/lorene /usr/local/apps/lorene' Export/C++/Include/bin_bh.h
+  CCTK_Search LORENE_DIR "$HOME_LORENE $LORENE_HOME /usr/local/lorene /usr/local/Lorene /usr/local/packages/lorene /usr/local/apps/lorene /opt/lorene /opt/Lorene" Export/C++/Include/bin_bh.h
   if [ -z "$LORENE_DIR" ] ; then
      echo "BEGIN ERROR"
-     echo 'Unable to locate the Lorene directory - please set LORENE_DIR'
+     echo 'Thorn LORENE requires an external installation of LORENE.  ' \
+          'Please set LORENE_DIR to specify the main directory of this ' \
+          'installation or remove LORENE from your ThornList.'
      echo "END ERROR"
      exit 2
   fi
   echo "BEGIN MESSAGE"
-  echo "Found a Lorene package in $LORENE_DIR"
+  echo "Found a LORENE package in $LORENE_DIR"
   echo "END MESSAGE"
 else
   echo "BEGIN MESSAGE"
-  echo "Using Lorene package in $LORENE_DIR"
+  echo "Using LORENE package in $LORENE_DIR"
   echo "END MESSAGE"
 fi
 
@@ -72,11 +74,11 @@
   LORENE_LIBS='lorene_export lorene lorenef77'
 else
   echo "BEGIN MESSAGE"
-  echo "Using Lorene libraries '$LORENE_LIBS'"
+  echo "Using LORENE libraries '$LORENE_LIBS'"
   echo "END MESSAGE"
 fi
 
-# Set the Lorene libs, libdirs and includedirs
+# Set the LORENE libs, libdirs and includedirs
 LORENE_LIB_DIRS='$(LORENE_DIR)/Lib $(LORENE_DIR)/Export/BinBH'
 LORENE_INC_DIRS='$(LORENE_DIR)/Export/C++/Include'
 
Index: doc/documentation.tex
===================================================================
RCS file: /cactusdevcvs/CactusExternal/LORENE/doc/documentation.tex,v
retrieving revision 1.1.1.1
diff -u -r1.1.1.1 documentation.tex
--- doc/documentation.tex	13 Apr 2004 21:09:07 -0000	1.1.1.1
+++ doc/documentation.tex	20 Oct 2005 13:29:26 -0000
@@ -99,7 +99,7 @@
 
 % Add an abstract for this thorn's documentation
 \begin{abstract}
-
+Adds LORENE capability to a configuration.
 \end{abstract}
 
 % The following sections are suggestive only.
@@ -107,31 +107,11 @@
 
 \section{Introduction}
 
-\section{Physical System}
-
-\section{Numerical Implementation}
-
-\section{Using This Thorn}
-
-\subsection{Obtaining This Thorn}
-
-\subsection{Basic Usage}
-
-\subsection{Special Behaviour}
-
-\subsection{Interaction With Other Thorns}
-
-\subsection{Examples}
-
-\subsection{Support and Feedback}
-
-\section{History}
-
-\subsection{Thorn Source Code}
-
-\subsection{Thorn Documentation}
-
-\subsection{Acknowledgements}
+The LORENE thorn provides Cactus with the capabilities of the LORENE package
+( \textbf{L}angage \textbf{O}bjet pour la \textbf{RE}lativit\'e
+\textbf{N}um\'eriqu\textbf{E} --
+see \url{http://www.lorene.obspm.fr/}), developed in the
+Meudon section of the Paris Observatory.
 
 
 \begin{thebibliography}{9}


--- StripMime Report -- processed MIME parts ---
multipart/mixed
  text/plain (text body -- kept)
  text/plain (text body -- kept)
---



More information about the Developers mailing list