Skip to content

Commit db2807d

Browse files
committed
some more clarification on installation options (more work needed)
1 parent cf5ddfd commit db2807d

File tree

2 files changed

+144
-161
lines changed

2 files changed

+144
-161
lines changed

installation.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ For parallelization *esys-escript* supports
4949
### General setup
5050

5151
The first step is to download the newest version of *esys-escript* source from
52-
[github](https://github.com/LutzGross/esys-escript.github.io) using
52+
[gitHub](https://github.com/LutzGross/esys-escript.github.io) using
5353

5454
mkdir esys6
5555
git clone --single-branch --branch master https://github.com/LutzGross/esys-escript.github.io.git esys6
@@ -61,8 +61,8 @@ After you have installed the required dependencies (see below) start *scons* to
6161

6262
scons -j4 options_file=scons/templates/<OS>_options.py
6363

64-
where `<OS>` is your operating system/kernel name. Typically the templates are assuming installation with MPI.
65-
By default libraries and *Python* modules are installed into `./lib/esys` and `./esys`, respectively.
64+
where `<OS>` is your operating system/kernel name. Typically, the templates are assuming installation with MPI.
65+
By default, libraries and *Python* modules are installed into `./lib/esys` and `./esys`, respectively.
6666
*Trilinos* libraries are installed into `esys.trilions/lib`. So you need to add
6767

6868
export PYTHONPATH=$ESYSESCRIPT
@@ -74,14 +74,13 @@ If you wish to test your build, you can use the following:
7474

7575
scons -j4 py_tests options_file=scons/templates/<OS>_options.py
7676

77-
If the options file of your operating system/kernel is not available yet or you want to modify the options
77+
If the options file of your operating system/kernel is not available yet, or you want to modify the options
7878
(for instance switching off MPI) you can create your own option file `scons/<HOST>_options.py` typically by copying and modifying one of the available
79-
template options files. `<HOST>` refers to the hostname which can be obtained by
79+
template options files in [scons/templates](scons/templates). `<HOST>` refers to the hostname which can be obtained by
8080

8181
HOST=`uname -n`
8282
echo $HOST
8383

84-
8584
Installation can then be run by
8685

8786
scons -j4
@@ -183,7 +182,7 @@ docker run -ti -v $(pwd):/app/ esys*esys-escript*/*esys-escript*\
183182

184183
### Parallelization
185184
It is likely that the computer you run *esys-escript* on, will have more than one processor core.
186-
*esys-escript* can make use of multiple cores in order to solve problems more quickly] if it is told to do so,
185+
*esys-escript* can make use of multiple cores in order to solve problems more quickly if it is told to do so,
187186
but this functionality must be enabled at compile time.
188187
Section~\ref{sec:needpar} gives some rough guidelines to help you determine what you need.
189188

@@ -243,7 +242,7 @@ manager\footnote{Note that package managers will make changes to your computer b
243242
various places around the internet. It is important to satisfy yourself as to the security of those systems.}.
244243
You can of course install prerequisite software in other ways.
245244
For example, we have had \emph{some} success changing the default
246-
compilers used by those systems. However this is more complicated and we do not provide a guide here.
245+
compilers used by those systems. However, this is more complicated, and we do not provide a guide here.
247246

248247
\noindent Both of those systems require the XCode command line tools to be installed\footnote{As of OSX10.9, the
249248
command \texttt{xcode-select --install} will allow you to download and install the commandline tools.}.
@@ -737,7 +736,7 @@ Note that a careless selection of these parameters may cause the testing program
737736

738737

739738
\esysappendix
740-
## Required compiler features}
739+
## Required compiler features
741740
\label{app:cxxfeatures}
742741

743742
Building *esys-escript* from source requires that your c++ compiler supports at least the following features:

0 commit comments

Comments
 (0)