Skip to content
Snippets Groups Projects
Commit b1465455 authored by Matthieu Schaller's avatar Matthieu Schaller
Browse files

Merge branch 'onboarding_changes' into 'master'

Changes to the onboarding guide to show how to specify library paths

See merge request !1898
parents af958c2d 5f5e8864
No related branches found
No related tags found
3 merge requests!1956Rename space_getsid to space_getsid_and_swap_cells() to try to prevent...,!1921Mhd canvas,!1898Changes to the onboarding guide to show how to specify library paths
......@@ -10,7 +10,7 @@ HDF5
Version 1.8.x or higher is required. Input and output files are stored as HDF5
and are compatible with the GADGET-2 specification. A parallel-HDF5 build
and HDF5 > 1.10.x is strongly recommended when running over MPI.
and HDF5 > 1.10.x is recommended when running over MPI.
MPI
~~~
......@@ -33,7 +33,15 @@ GSL
~~~
The GSL 2.x is required for cosmological integration.
In most cases the configuration script will be able to detect the libraries
installed on the system. If that is not the case, the script can be pointed
towards the libraries' location using the following parameters
.. code-block:: bash
./configure --with-gsl=<PATH-TO-GSL>
and similar for the other libaries.
Optional Dependencies
=====================
......@@ -48,10 +56,6 @@ TCmalloc/Jemalloc/TBBmalloc
~~~~~~~~~~~~~~~~~~~~~~~~~~~
TCmalloc/Jemalloc/TBBmalloc are used for faster memory allocations when available.
DOXYGEN
~~~~~~~
You can build documentation for SWIFT with DOXYGEN.
Python
~~~~~~
To run the examples, you will need python 3 and some of the standard scientific libraries (numpy, matplotlib).
......
......@@ -13,13 +13,13 @@ We use autotools for setup. To get a basic running version of the code (the exec
MacOS Specific Oddities
~~~~~~~~~~~~~~~~~~~~~~~
To build on MacOS you will need to disable compiler warnings due to an
To build on MacOS you will need to enable compiler warnings due to an
incomplete implementation of pthread barriers. DOXYGEN also has some issues on
MacOS, so it is best to leave it out. To configure:
.. code-block:: bash
./configure --disable-compiler-warnings \
./configure --enable-compiler-warnings \
--disable-doxygen-doc
When using the ``clang`` compiler, the hand-written vectorized routines
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment