]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Clarify some text. 6544/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Wed, 9 May 2018 00:10:24 +0000 (08:10 +0800)
committerWolfgang Bangerth <bangerth@colostate.edu>
Wed, 9 May 2018 00:10:24 +0000 (08:10 +0800)
doc/readme.html

index d072b5f68b1602dc914ef820e52d154e79d860c5..20cabcb76c9d4c49fde7e7c604e3013a8ce22f62 100644 (file)
         <dd>
             <p>
                 <a href="https://projects.coin-or.org/ADOL-C" target="_top">ADOL-C</a> is a package that facilitates the evaluation of first and higher derivatives of vector functions. In particular, it can be used for automatic differentiation. For using
-                <a href="https://projects.coin-or.org/ADOL-C/" target="_top">ADOL-C</a> with deal.II, version 2.6.4 or newer is required. To use a self compiled version, specify
-                <code>-DADOLC_DIR=/path/to/adolc</code> on the command line.
+                <a href="https://projects.coin-or.org/ADOL-C/" target="_top">ADOL-C</a> with deal.II, version 2.6.4 or newer is required. To use a self compiled version, pass
+                <code>-DADOLC_DIR=/path/to/adolc</code> to the deal.II CMake call.
             </p>
         </dd>
 
         <dd>
             <p>
                 <a href="http://www.caam.rice.edu/software/ARPACK/" target="_top">ARPACK</a> is a library for computing large scale eigenvalue problems.
-                <a href="http://www.caam.rice.edu/software/ARPACK/" target="_top">ARPACK</a> should be readily packaged by most Linux distributions. To use a self compiled version, specify
-                <code>-DARPACK_DIR=/path/to/arpack</code> on the command line. For a detailed description on how to compile ARPACK and linking with deal.II, see
+                <a href="http://www.caam.rice.edu/software/ARPACK/" target="_top">ARPACK</a> should be readily packaged by most Linux distributions. To use a self compiled version, pass
+                <code>-DARPACK_DIR=/path/to/arpack</code> to the deal.II CMake call. For a detailed description on how to compile ARPACK and linking with deal.II, see
                 <a href="external-libs/arpack.html" target="body">this page</a>.
             </p>
         </dd>
             <p>
                 <a href="http://www.assimp.org/" target="_top"></a> is a portable Open Source library to import various well-known 3D model formats in a uniform manner. A subset of these formats can be read from within deal.II to generate two-dimensional
                 meshes, possibly embedded in a three-dimensional space.
-                <a href="http://www.assimp.org/" target="_top">Assimp</a> should be readily packaged by most Linux distributions. To use a self compiled version, specify
-                <code>-DASSIMP_DIR=/path/to/assimp</code> on the command line.
+                <a href="http://www.assimp.org/" target="_top">Assimp</a> should be readily packaged by most Linux distributions. To use a self compiled version, pass
+                <code>-DASSIMP_DIR=/path/to/assimp</code> to the deal.II CMake call.
             </p>
         </dd>
 
             <dd>
                 <p>
                     The <a href="http://www.gnu.org/software/gsl/">GNU Scientific Library</a> provides a wide range of mathematical routines such as random number generators, special functions and least-squares fitting.
-                    <a href="http://www.gnu.org/software/gsl/">GSL</a> should be readily packaged by most Linux distributions. To use a self compiled version, specify
-                    <code>-DGSL_DIR=/path/to/gsl</code> on the command line.
+                    <a href="http://www.gnu.org/software/gsl/">GSL</a> should be readily packaged by most Linux distributions. To use a self compiled version, pass
+                    <code>-DGSL_DIR=/path/to/gsl</code> to the deal.II CMake call.
                 </p>
             </dd>
 
             <dd>
                 <p>
                     The <a href="http://www.hdfgroup.org/HDF5/">HDF5 library</a> provides graphical output capabilities in <code>HDF5/XDMF</code> format.
-                    <a href="http://www.hdfgroup.org/HDF5/">HDF5</a> should be readily packaged by most Linux distributions. To use a self compiled version, specify
-                    <code>-DHDF5_DIR=/path/to/hdf5</code> on the command line.
+                    <a href="http://www.hdfgroup.org/HDF5/">HDF5</a> should be readily packaged by most Linux distributions. To use a self compiled version, pass
+                    <code>-DHDF5_DIR=/path/to/hdf5</code> to the deal.II CMake call.
                 </p>
             </dd>
 
             <dd>
                 <p>
                     <a href="http://glaros.dtc.umn.edu/gkhome/metis/metis/overview" target="_top">METIS</a> is a library that provides various methods to partition graphs. <acronym>deal.II</acronym> uses it in programs like the step-17 tutorial to partition
-                    a mesh for parallel computing. To use a self compiled version, specify
-                    <code>-DMETIS_DIR=/path/to/metis</code> on the command line.
+                    a mesh for parallel computing. To use a self compiled version, pass
+                    <code>-DMETIS_DIR=/path/to/metis</code> to the deal.II CMake call.
                     <acronym>deal.II</acronym> supports METIS 5 and later.
                 </p>
 
                 <p>
                     <a href="https://github.com/jlblancoc/nanoflann" target="_top">nanoflann</a> is a C++11 header-only library for building KD-Trees of datasets with different topologies. In particular, it can be used for operations such as finding the
                     vertex or cell closest to a given evaluation point that occur frequently in many applications using unstructured meshes. scale eigenvalue problems.
-                    <a href="https://github.com/jlblancoc/nanoflann" target="_top">nanoflann</a> should be readily packaged by most Linux distributions. To use a self compiled version, specify
-                    <code>-DNANOFLANN_DIR=/path/to/nanoflann</code> on the command line.
+                    <a href="https://github.com/jlblancoc/nanoflann" target="_top">nanoflann</a> should be readily packaged by most Linux distributions. To use a self compiled version, pass
+                    <code>-DNANOFLANN_DIR=/path/to/nanoflann</code> to the deal.II CMake call.
                 </p>
             </dd>
 
                     <a href="https://computation.llnl.gov/projects/sundials" target="_top">SUNDIALS</a> is a collection of solvers for nonlinear and differential/algebraic equations.
                     <a href="https://computation.llnl.gov/projects/sundials" target="_top">SUNDIALS</a> should be readily packaged by most Linux distributions. To use a self compiled version,
                     specify
-                    <code>-DSUNDIALS_DIR=/path/to/sundials</code> on the command line.
+                    <code>-DSUNDIALS_DIR=/path/to/sundials</code> to the deal.II CMake call.
                 </p>
             </dd>
 
     <dd>
         <p>
             <a href="http://zlib.net/" target="_top">zlib</a> is a software library used for lossless data-compression. It is used in deal.II whenever compressed data is to be written.
-            <a href="http://zlib.net/" target="_top">zlib</a> should be readily packaged by most Linux distributions. To use a self compiled version, specify
-            <code>-DZLIB_DIR=/path/to/zlib</code> on the command line.
+            <a href="http://zlib.net/" target="_top">zlib</a> should be readily packaged by most Linux distributions. To use a self compiled version, pass
+            <code>-DZLIB_DIR=/path/to/zlib</code> to the deal.II CMake call.
         </p>
     </dd>
 

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.