Commit a11e94f0 authored by Cristian Lalescu's avatar Cristian Lalescu
Browse files

tweak readme

parent 6abc567b
Pipeline #63988 passed with stage
in 4 minutes and 9 seconds
......@@ -33,9 +33,9 @@ as well as to generate job submission scripts for clusters and to
perform basic post-processing of simulation results.
The primary aim of TurTLE is to provide optimal performance, while
reducing the time spent on setting up and supervising DNS, with the
added benefit of a unified launch-postprocess approach through the use
of the Python wrapper.
reducing the time spent on setting up and supervising ensembles of DNS,
with the added benefit of a unified launch-postprocess approach through
the use of the Python wrapper.
.. _sec-installation:
......@@ -63,29 +63,21 @@ of existing data is desired:
The C++ library requires a number of dependencies, that `CMake` will
search for before compilation and installation.
In brief, an MPI compiler is required, the HDF5 C library compiled with
parallel support and FFTW >= 3.4.
In brief, an MPI compiler is required, as well as the HDF5 C library
compiled with parallel support and FFTW >= 3.4.
Detailed instructions are provided at the end of this document.
-------------
Documentation
-------------
While the code is not fully documented yet, basic information is already
available, and it is recommended that you generate the manual and go
through it carefully.
Please do ask for specific improvements to the current text where it is
found lacking.
In order to generate the manual, navigate to the repository folder, and
execute the following commands:
.. code:: bash
cd documentation
make latexpdf
Optionally, html documentation can be generated instead if needed, just
type ``make html`` instead of ``make latexpdf``.
Partial documentation is available (link to online documentation coming
soon).
Doxygen is used for the C++ source code, and the `Sphinx` and `breathe`
Python packages are used to merge the Python wrapper documentation with
the C++ documentation.
The optional `CMake` targets `doc_doxygen`, `doc_html` and `doc_latex`
generate the required documents in the build directory.
--------
Comments
......@@ -167,7 +159,8 @@ Detailed full installation instructions:
TurTLE will try to find FFTW using the FindFFTW from the Morse project.
If the package is installed in a non standard location, it is recommanded
to setup the environment variables: `FFTW_DIR`, `FFTW_INCDIR` and `FFTW_LIBDIR`.
to setup the environment variables: `FFTW_DIR`, `FFTW_INCDIR`,
`FFTW_LIBDIR`, `FFTW_OPEMMP_LIBDIR` and `FFTW_MPI_LIBDIR`.
4.
Download, compile, install HDF5 (version 1.8.x, currently available
......@@ -184,7 +177,7 @@ Detailed full installation instructions:
Therefore, if the package is installed in a non standard location, it is recommanded
to setup the environment variable: HDF5_ROOT.
5. TurTLE requires `cmake` version > 3.6 (possibly 3.12).
5. TurTLE requires `cmake` version > 3.12.
If required, download, compile and install cmake, currently
available at https://cmake.org/cmake/resources/software.html.
......@@ -196,7 +189,9 @@ Detailed full installation instructions:
5.
Optional.
We recommend the creation of a virtual python3 environment (also under PREFIX) that will be used for installing TurTLE and dependencies.
We recommend the creation of a virtual python3 environment (also
under PREFIX) that will be used for installing TurTLE and
dependencies.
Please see https://docs.python-guide.org/dev/virtualenvs/.
6.
......@@ -252,10 +247,11 @@ Detailed full installation instructions:
Scaling tests.
--------------------
Initial scaling data is available at <insert url here>.
Initial scaling data is available at (url coming soon).
Please copy the files to the location `TURTLE_FIELD_DATABASE`.
Separately, please recompile TurTLE after appending "-D USE_TIMINGOUTPUT" to the `TURTLE_COMPILATION_FLAGS` environment variable
Separately, please recompile TurTLE with the `TIMING_OUTPUT` cmake
option switched to `ON`.
Afterwards, please run variations of the following command:
......
#! /bin/bash
export MPICXX=<please insert appropriate executable here>
export CUSTOM_INSTALL_PATH=<please insert your prefered path here. I recommend the location of your python virtual environment>
export CUSTOM_INSTALL_PATH=<please insert your prefered path here. We recommend the location of your python virtual environment>
export PATH=${CUSTOM_INSTALL_PATH}/bin:${PATH}
export FFTW_DIR=${CUSTOM_INSTALL_PATH}
export FFTW_BASE=${FFTW_DIR}
......@@ -11,5 +11,5 @@ export HDF5_BASE=${HDF5_DIR}
export HDF5_ROOT=${HDF5_DIR}
export CMAKE_PREFIX_PATH=${CUSTOM_INSTALL_PATH}/lib
#export TURTLE_OPTIMIZATION_FLAGS="-O3 -mtune=native -ffast-math -DNDEBUG"
export TURTLE_OPTIMIZATION_FLAGS="-DUSE_TIMINGOUTPUT"
#export TURTLE_COMPILATION_FLAGS="-O3 -mtune=native -ffast-math"
export TURTLE_COMPILATION_FLAGS=""
Supports Markdown
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