/[escript]/branches/doubleplusgood/doc/install/srclinux.tex
ViewVC logotype

Diff of /branches/doubleplusgood/doc/install/srclinux.tex

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 3321 by caltinay, Tue Oct 12 04:42:03 2010 UTC revision 3322 by jfenwick, Thu Oct 28 05:26:37 2010 UTC
# Line 15  Line 15 
15    
16  \subsection{Preliminaries}  \subsection{Preliminaries}
17    
18  The following instructions assume you are running the \filename{bash} shell.  The following instructions assume you are running the \file{bash} shell.
19  Comments are indicated with \# characters.  Comments are indicated with \# characters.
20    
21  Make sure you have the following installed:  Make sure you have the following installed:
22  \begin{itemize}  \begin{itemize}
23   \item \filename{g++} and associated tools.   \item \file{g++} and associated tools.
24   \item \filename{make}   \item \file{make}
25   % I suspect that these are only needed by VTK and if we aren't using it anymore they could be removed   % I suspect that these are only needed by VTK and if we aren't using it anymore they could be removed
26  %  \item \filename{libXext.so}\footnote{In Debian this is in the libXext-dev package.}  %  \item \file{libXext.so}\footnote{In Debian this is in the libXext-dev package.}
27  %  \item \filename{libxt.so}\footnote{In Debian this is in the libxt-dev package.}  %  \item \file{libxt.so}\footnote{In Debian this is in the libxt-dev package.}
28  \end{itemize}  \end{itemize}
29    
30  To compile matplotlib you will also need the following\footnote{For Debian and Ubuntu users, installing \filename{libfreetype6-dev} and \filename{libpng-dev} will be sufficient.} (if your distribution separates development files,  To compile matplotlib you will also need the following\footnote{For Debian and Ubuntu users, installing \file{libfreetype6-dev} and \file{libpng-dev} will be sufficient.} (if your distribution separates development files,
31  make sure to get the development packages):  make sure to get the development packages):
32  \begin{itemize}  \begin{itemize}
33   \item \filename{freetype2}   \item \file{freetype2}
34  \item \filename{zlib}  \item \file{zlib}
35  \item \filename{libpng}  \item \file{libpng}
36  \end{itemize}  \end{itemize}
37    
38    
39    
40  You will also need a copy of the \esfinley source code.  You will also need a copy of the \esfinley source code.
41  If you retrieved the source using subversion, don't forget that one can use the export command instead of checkout to get a smaller copy.  If you retrieved the source using subversion, don't forget that one can use the export command instead of checkout to get a smaller copy.
42  For additional visualization functionality see \Sec{sec:addfunc}.  For additional visualization functionality see Section~\ref{sec:addfunc}.
43    
44  These instructions will produce the following directory structure:  These instructions will produce the following directory structure:
45  \begin{itemize}  \begin{itemize}
46   \item[] \filename{stand} \begin{itemize}   \item[] \file{stand} \begin{itemize}
47    \item[] \filename{escript.d}    \item[] \file{escript.d}
48    \item[] \filename{pkg}    \item[] \file{pkg}
49    \item[] \filename{pkg_src}    \item[] \file{pkg_src}
50    \item[] \filename{build}    \item[] \file{build}
51    \item[] \filename{doc}    \item[] \file{doc}
52   \end{itemize}   \end{itemize}
53  \end{itemize}  \end{itemize}
54    
55  Before you start copy the \esfinley source into the \filename{escript.d} directory.  Before you start copy the \esfinley source into the \file{escript.d} directory.
56  The following instructions refer to software versions in the \filename{escript-support-3-src} bundle.  The following instructions refer to software versions in the \file{escript-support-3-src} bundle.
57  If you download your own versions of those packages substitute their version numbers and names as appropriate.  If you download your own versions of those packages substitute their version numbers and names as appropriate.
58  There are a number of uses of the \filename{make} command in the following instructions.  There are a number of uses of the \file{make} command in the following instructions.
59  If your computer has multiple cores/processors you can speed up the compilation process by adding -j 2 after the make command.  If your computer has multiple cores/processors you can speed up the compilation process by adding -j 2 after the make command.
60  For example to use all processors on a computer with 4 cores:  For example to use all processors on a computer with 4 cores:
61  \begin{shellCode}  \begin{shellCode}
# Line 75  export PKG_ROOT=$(pwd)/pkg Line 75  export PKG_ROOT=$(pwd)/pkg
75    
76  \subsection{Building the dependencies}  \subsection{Building the dependencies}
77    
78  Copy the compressed sources for the packages into \filename{stand/pkg_src}.  Copy the compressed sources for the packages into \file{stand/pkg_src}.
79  If you are using the support bundles, decompress them in the stand directory:  If you are using the support bundles, decompress them in the stand directory:
80  \begin{shellCode}  \begin{shellCode}
81  tar -xjf escript-support-3-src.tar.bz2  tar -xjf escript-support-3-src.tar.bz2
82  \end{shellCode}  \end{shellCode}
83    
84  Copy documentation files into \filename{doc} then unpack the archives:  Copy documentation files into \file{doc} then unpack the archives:
85    
86  \begin{shellCode}  \begin{shellCode}
87  cd build  cd build
# Line 206  cd .. Line 206  cd ..
206    
207  % \subsection{VTK support}  % \subsection{VTK support}
208  % VTK is only required for pyvisi. To build it you need CMake and Mesa.  % VTK is only required for pyvisi. To build it you need CMake and Mesa.
209  % The packages can be downloaded independently or in the \filename{escript-support-visi-3-src}.  % The packages can be downloaded independently or in the \file{escript-support-visi-3-src}.
210  % If you will not be using pyvisi, then skip to \Sec{sec:compileescriptlinux}  % If you will not be using pyvisi, then skip to \Sec{sec:compileescriptlinux}
211  %  %
212  % Copy the compressed sources for the packages into \filename{stand/pkg_src}.  % Copy the compressed sources for the packages into \file{stand/pkg_src}.
213  % If you are using the support bundles, decompress them in the stand directory.  % If you are using the support bundles, decompress them in the stand directory.
214  % \begin{shellCode}  % \begin{shellCode}
215  % tar -xjf escript-support-visi-3-src.tar.bz2  % tar -xjf escript-support-visi-3-src.tar.bz2
# Line 262  cd .. Line 262  cd ..
262  % cmake .  % cmake .
263  % \end{shellCode}  % \end{shellCode}
264  %  %
265  % Now edit the \filename{CMakeCache.txt} file and make the following changes.  % Now edit the \file{CMakeCache.txt} file and make the following changes.
266  % Where .... appears please replace it with the absolute path to the pkg directory.  % Where .... appears please replace it with the absolute path to the pkg directory.
267  % For example, replace \filename{CMAKE_INSTALL_PREFIX:PATH=..../vtk-5.2.1} with  % For example, replace \file{CMAKE_INSTALL_PREFIX:PATH=..../vtk-5.2.1} with
268  % \filename{CMAKE_INSTALL_PREFIX:PATH=/home/bob/stand/pkg/vtk-5.2.1}  % \file{CMAKE_INSTALL_PREFIX:PATH=/home/bob/stand/pkg/vtk-5.2.1}
269  % (Search for the text before the =).  % (Search for the text before the =).
270  % \begin{shellCode}  % \begin{shellCode}
271  % BUILD_EXAMPLES:BOOL=OFF  % BUILD_EXAMPLES:BOOL=OFF
# Line 284  cd .. Line 284  cd ..
284  % cmake .  % cmake .
285  % \end{shellCode}  % \end{shellCode}
286  %  %
287  % Edit \filename{CMakeCache.txt} and change the following variables:  % Edit \file{CMakeCache.txt} and change the following variables:
288  %  %
289  % \begin{shellCode}  % \begin{shellCode}
290  % VTK_USE_OFFSCREEN:BOOL=ON  % VTK_USE_OFFSCREEN:BOOL=ON
# Line 313  cd .. Line 313  cd ..
313    
314  \subsection{Compiling escript}\label{sec:compileescriptlinux}  \subsection{Compiling escript}\label{sec:compileescriptlinux}
315    
316  Change to the directory containing your escript source (\filename{stand/escript.d}), then:  Change to the directory containing your escript source (\file{stand/escript.d}), then:
317    
318  \begin{shellCode}  \begin{shellCode}
319  cd escript.d/scons  cd escript.d/scons
# Line 323  echo $PKG_ROOT Line 323  echo $PKG_ROOT
323  \end{shellCode}  \end{shellCode}
324  Where \texttt{YourMachineName} is the name of your computer as returned by the hostname command.  Where \texttt{YourMachineName} is the name of your computer as returned by the hostname command.
325  If the name contains non-alphanumeric characters, then you will need to replace them with underscores.  If the name contains non-alphanumeric characters, then you will need to replace them with underscores.
326  For example the options file for \texttt{bob-desktop} would be named \filename{bob_desktop_options.py}.  For example the options file for \texttt{bob-desktop} would be named \file{bob_desktop_options.py}.
327    
328  Edit the options file and put the value of PKG_ROOT between the quotes in the PKG_ROOT= line.  Edit the options file and put the value of PKG_ROOT between the quotes in the PKG_ROOT= line.
329  For example:  For example:
# Line 335  PKG_ROOT="/home/bob/stand/pkg" Line 335  PKG_ROOT="/home/bob/stand/pkg"
335  cd ../bin  cd ../bin
336  \end{shellCode}  \end{shellCode}
337    
338  Modify the STANDALONE line of \filename{run-escript} to read:  Modify the STANDALONE line of \file{run-escript} to read:
339    
340  STANDALONE=1  STANDALONE=1
341    
342  Start a new terminal and go to the \filename{stand} directory.  Start a new terminal and go to the \file{stand} directory.
343    
344  \begin{shellCode}  \begin{shellCode}
345  export PATH=$(pwd)/pkg/scons/bin:$PATH  export PATH=$(pwd)/pkg/scons/bin:$PATH
# Line 355  scons all_tests Line 355  scons all_tests
355  \end{shellCode}  \end{shellCode}
356    
357  \subsection{Cleaning up}  \subsection{Cleaning up}
358  Once you are satisfied, the \filename{escript.d/build} and \filename{\$PKG_ROOT/build} directories can be removed.  Once you are satisfied, the \file{escript.d/build} and \file{\$PKG_ROOT/build} directories can be removed.
359    
360  If you \emph{really} want to save space and do not wish to be able to edit or recompile \esfinley, you can remove the following:  If you \emph{really} want to save space and do not wish to be able to edit or recompile \esfinley, you can remove the following:
361  \begin{itemize}  \begin{itemize}
362   \item From the \filename{escript.d} directory:\begin{itemize}   \item From the \file{escript.d} directory:\begin{itemize}
363  \item Everything except: \filename{bin}, \filename{include}, \filename{lib}, \filename{esys},  \item Everything except: \file{bin}, \file{include}, \file{lib}, \file{esys},
364  \filename{README_LICENSE}.  \file{README_LICENSE}.
365  \item Hidden files, which can be removed using  \item Hidden files, which can be removed using
366  \begin{shellCode}  \begin{shellCode}
367  find . -name '.?*' | xargs rm -rf  find . -name '.?*' | xargs rm -rf
368  \end{shellCode}  \end{shellCode}
369  in the \filename{escript.d} directory.  in the \file{escript.d} directory.
370  \end{itemize}  \end{itemize}
371  \item from the \filename{pkg} directory:  \item from the \file{pkg} directory:
372  \begin{itemize}  \begin{itemize}
373  \item  \filename{scons}, \filename{scons-1.2.0}, \filename{cmake-2.6.3} and \filename{cmake}  \item  \file{scons}, \file{scons-1.2.0}, \file{cmake-2.6.3} and \file{cmake}
374  \end{itemize}  \end{itemize}
375  \item \filename{package\_src}\footnote{Do not remove this if you intend to redistribute.}.  \item \file{package\_src}\footnote{Do not remove this if you intend to redistribute.}.
376  \end{itemize}  \end{itemize}
377    
378  Please note that removing all these files may make it more difficult for us to diagnose problems.  Please note that removing all these files may make it more difficult for us to diagnose problems.

Legend:
Removed from v.3321  
changed lines
  Added in v.3322

  ViewVC Help
Powered by ViewVC 1.1.26