Skip to content
Snippets Groups Projects
Commit fd93306a authored by Benjamin Cumming's avatar Benjamin Cumming Committed by Sam Yates
Browse files

Update redundant info in installation docs (#567)

Fixes #564
parent 120316d0
No related branches found
No related tags found
No related merge requests found
...@@ -180,10 +180,9 @@ For more detailed build configuration options, see the `quick start <quickstart_ ...@@ -180,10 +180,9 @@ For more detailed build configuration options, see the `quick start <quickstart_
make -j 4 make -j 4
# 4) Run tests. # 4) Run tests.
./test/test.exe ./bin/unit
./test/global_communication.exe
# 5) Install (by default, to /usrlocal). # 5) Install (by default, to /usr/local).
make install make install
This will build Arbor in release mode with the `default C++ compiler <note_CC_>`_. This will build Arbor in release mode with the `default C++ compiler <note_CC_>`_.
...@@ -372,8 +371,7 @@ MPI ...@@ -372,8 +371,7 @@ MPI
Arbor uses MPI for distributed systems. By default it is built without MPI support, which Arbor uses MPI for distributed systems. By default it is built without MPI support, which
can enabled by setting the ``ARB_WITH_MPI`` configuration flag. can enabled by setting the ``ARB_WITH_MPI`` configuration flag.
An example of building a 'release' (optimized) version of Arbor with MPI: An example of building a 'release' (optimized) version of Arbor with MPI is:
is:
.. code-block:: bash .. code-block:: bash
...@@ -381,14 +379,11 @@ is: ...@@ -381,14 +379,11 @@ is:
export CC=`which mpicc` export CC=`which mpicc`
export CXX=`which mpicxx` export CXX=`which mpicxx`
# configure with mpi, tbb threading and compiled with optimizations # configure with mpi
cmake .. -DARB_WITH_MPI=ON \ # Use MPI cmake .. -DARB_WITH_MPI=ON
-DCMAKE_BUILD_TYPE=release # Optimizations on
# run unit tests for global communication on 2 MPI ranks # run MPI-specific unit tests on 2 MPI ranks
mpirun -n 2 ./tests/global_communication.exe mpirun -n 2 ./bin/unit-mpi
(Note that 'release' build is in fact the default configuration for Arbor.)
The example above sets the ``CC`` and ``CXX`` environment variables to use compiler The example above sets the ``CC`` and ``CXX`` environment variables to use compiler
wrappers provided by the MPI implementation. While the configuration process wrappers provided by the MPI implementation. While the configuration process
...@@ -415,16 +410,16 @@ using the supplied MPI compiler wrappers in preference. ...@@ -415,16 +410,16 @@ using the supplied MPI compiler wrappers in preference.
Cray Systems Cray Systems
------------ ------------
The compiler used by the MPI wrappers is set using a "programming enviroment" module. The compiler used by the MPI wrappers is set using a "programming environment" module.
The first thing to do is change this module, which by default is set to the Cray The first thing to do is change this module, which by default is set to the Cray
programming environment. programming environment, to a compiler that can compile Arbor.
For example, to use the GCC compilers, select the GNU programming enviroment: For example, to use the GCC compilers, select the GNU programming enviroment:
.. code-block:: bash .. code-block:: bash
module swap PrgEnv-cray PrgEnv-gnu module swap PrgEnv-cray PrgEnv-gnu
The version of the GCC can then be set by choosing an appropriate gcc module. The version of GCC can then be set by choosing an appropriate gcc module.
In the example below we use ``module avail`` to see which versions of GCC are available, In the example below we use ``module avail`` to see which versions of GCC are available,
then choose GCC 7.1.0 then choose GCC 7.1.0
...@@ -456,8 +451,7 @@ enviroment variable to ``dynamic``. ...@@ -456,8 +451,7 @@ enviroment variable to ``dynamic``.
export CRAYPE_LINK_TYPE=dynamic export CRAYPE_LINK_TYPE=dynamic
Putting it all together, a typicaly workflow to configure the environment and CMake, Putting it all together, a typical workflow to build Arbor on a Cray system is:
then build Arbor is:
.. code-block:: bash .. code-block:: bash
...@@ -465,8 +459,7 @@ then build Arbor is: ...@@ -465,8 +459,7 @@ then build Arbor is:
module swap PrgEnv-cray PrgEnv-gnu module swap PrgEnv-cray PrgEnv-gnu
moudle swap gcc/7.1.0 moudle swap gcc/7.1.0
export CC=`which cc`; export CXX=`which CC`; export CC=`which cc`; export CXX=`which CC`;
cmake .. -DARB_WITH_MPI=ON \ # MPI support cmake .. -DARB_WITH_MPI=ON # MPI support
-DCMAKE_BUILD_TYPE=release # optimized
.. Note:: .. Note::
If ``CRAYPE_LINK_TYPE`` isn't set, there will be warnings like the following when linking: If ``CRAYPE_LINK_TYPE`` isn't set, there will be warnings like the following when linking:
...@@ -583,7 +576,7 @@ instructions used by KNL. ...@@ -583,7 +576,7 @@ instructions used by KNL.
.. code-block:: none .. code-block:: none
$ ./tests/test.exe $ ./bin/unit
Illegal instruction (core dumped) Illegal instruction (core dumped)
On the Cray KNL system, ``srun`` is used to launch (it might be ``mpirun`` On the Cray KNL system, ``srun`` is used to launch (it might be ``mpirun``
...@@ -591,7 +584,7 @@ instructions used by KNL. ...@@ -591,7 +584,7 @@ instructions used by KNL.
.. code-block:: none .. code-block:: none
$ srun -n1 -c1 ./tests/test.exe $ srun -n1 -c1 ./bin/unit
[==========] Running 609 tests from 108 test cases. [==========] Running 609 tests from 108 test cases.
[----------] Global test environment set-up. [----------] Global test environment set-up.
[----------] 15 tests from algorithms [----------] 15 tests from algorithms
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment