diff --git a/doc/htmldoc/installation/cmake_options.rst b/doc/htmldoc/installation/cmake_options.rst index ed72a32f5b..f6c70c1c5a 100644 --- a/doc/htmldoc/installation/cmake_options.rst +++ b/doc/htmldoc/installation/cmake_options.rst @@ -116,17 +116,17 @@ The following options help to optimize NEST for maximal performance and thus red .. note:: - * In our experience, gains from these optimizations are not very large. I can still be sensible to test them, - especially if you are going to perform large numbers of simulations. - * Your particular use case may touch upon corner cases in NEST execution that our extensive test suite has - not covered. Internal consistency tests in NEST in form of ``assert()`` statements can help to detect such - corner cases. Using the optimization options above removes these internal checks and thus increases the + * In our experience, gains from these optimizations are not very large. It can still be sensible to test them, + especially if you are going to perform a large number of simulations. + * Your particular use case may contain edge cases during NEST execution that our extensive test suite has + not covered. Internal consistency tests in NEST in the form of ``assert()`` statements can help to detect such + edge cases. Using the optimization options above removes these internal checks and thus increases the risk that NEST will produce incorrect results. Therefore, use these options *only after you have performed - multiple simulations of your specific model with default optimization settings* (i.e., ``-O2``) and assertions - thus in place. + multiple simulations of your specific model with default optimization settings* (i.e., ``-O2``), which leaves the assertions + in place. * Using ``-march=native`` requires that you build NEST on the same CPU architecture as you will use to run it. - * For the technically minded: Even just using ``-O3`` removes some ``assert()``s from NEST since we - have wrapped some of them in functions which get eliminated due to interprocedural optimization. ``` + * For the technically minded: Even just using ``-O3`` removes some ``assert()`` statements from NEST since we + have wrapped some of them in functions, which get eliminated due to interprocedural optimization.