Skip to content

Commit 106cc9f

Browse files
authored
Quick fix on the documentation (#1012)
Description of the problem Lethe's page leaded to dummy page, so I directed index to the right file. Quick fix on installation guide for linux. How Has This Been Tested? Documentation Installation guide for linux Co-authored-by: voferreira <[email protected]>
1 parent a3a1d26 commit 106cc9f

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

doc/source/installation/regular_installation.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -106,13 +106,13 @@ From the candi folder, the installation of candi can be launched using:
106106
.. code-block:: text
107107
:class: copy-button
108108
109-
./candi.sh -j $num_proc --prefix=$path
109+
./candi.sh -j$numproc --prefix=$path
110110
111111
112-
where ``$num_proc`` is the number of threads you want to use to compile deal.II and ``$path`` the installation prefix that is desired (e.g. ``/home/username/software/candi``).
112+
where ``$numproc`` is the number of threads you want to use to compile deal.II and ``$path`` the installation prefix that is desired (e.g. ``/home/username/software/candi``).
113113

114114
.. tip::
115-
For a computer with 8Gb of RAM, 1 thread (``num_proc=1``) should be used. For 16 Gb, 4 threads is reasonable. For 32 Gb, 16 threads or more can be used.
115+
For a computer with 8Gb of RAM, 1 thread (``numproc=1``) should be used. For 16 Gb, 4 threads is reasonable. For 32 Gb, 16 threads or more can be used.
116116

117117

118118
After installation, you should have a ``deal.II-candi`` folder in the installation prefix directory, with the dealii folder of the desired version (see section :ref:`update-dealii`), as well as the required dependencies (p4est, trilinos, etc.).
@@ -123,7 +123,7 @@ After installation, add the following lines variable to your ``.bashrc`` :
123123
:class: copy-button
124124
125125
source cand/install/prefix/configuration/enable.sh
126-
export DEAL_II_DIR=cand/install/prefix/deal.II-<version> >> ~/.bashrc
126+
export DEAL_II_DIR=cand/install/prefix/deal.II-v.<version>
127127
128128
129129
.. _install-lethe:
@@ -165,7 +165,7 @@ Then you can compile:
165165
.. code-block:: text
166166
:class: copy-button
167167
168-
make -j<numprocs>
168+
make -j$numprocs
169169
170170
Testing Your Installation
171171
-------------------------------------
@@ -175,7 +175,7 @@ Lethe comes pre-packaged with an extensive test suit for all of its modules. It
175175
.. code-block:: text
176176
:class: copy-button
177177
178-
ctest -j $numprocs
178+
ctest -j$numprocs
179179
180180
where $numprocs can be the number of physical cores on your machine.
181181

@@ -215,7 +215,7 @@ Compile deal.II
215215
.. code-block:: text
216216
:class: copy-button
217217
218-
make -j<nprocessor> install
218+
make -j$numprocs install
219219
220220
Create an environment variable for the deal.II directory
221221

0 commit comments

Comments
 (0)