Skip to content

Commit

Permalink
Merge pull request #413 from mkstoyanov/final_alignment
Browse files Browse the repository at this point in the history
* aligned the example code snippets to 100 characters
* added a list of known issues on release time
  • Loading branch information
mkstoyanov authored Sep 30, 2019
2 parents e5ff4c0 + de365ff commit 652523c
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 6 deletions.
26 changes: 23 additions & 3 deletions Doxygen/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ The preferred way to install Tasmanian is to use the included CMake build script
-D Tasmanian_ENABLE_MPI:BOOL=<ON/OFF> (mostly stable)
-D Tasmanian_ENABLE_DOXYGEN:BOOL=<ON/OFF> (mostly stable)
```

* Acceleration options:
* OpenMP allows Tasmanian to use more than one CPU core, which greatly increases the performance
* Basic Linear Algebra Subroutines (BLAS) is a standard with many implementations,
Expand Down Expand Up @@ -192,7 +193,7 @@ Tasmanian is also included in Spack: [https://spack.io/](https://spack.io/)

### Install on MS Windows platform

Tasmanian has been tested with MS Visual Studio 2015 and 2017 and CMake 3.11.
Tasmanian has been tested with MS Visual Studio 2017 and CMake 3.11.

* First use the CMake GUI to set the folders and options
* Then use the command prompt (`cmd.exe`) to enter the build folder
Expand All @@ -202,7 +203,7 @@ Tasmanian has been tested with MS Visual Studio 2015 and 2017 and CMake 3.11.
ctest -C Release
cmake --build . --config Release --target install
```
* Both Debug and Release are supported config modes above
* Both Debug and Release are supported config modes, but do not use simultaneously

### Install folder structure

Expand Down Expand Up @@ -288,4 +289,23 @@ For example:
find_package(... OPTIONAL_COMPONENTS SHARED) # Tasmanian::Tasmanian is shared
find_package(... REQUIRED SHARED OPTIONAL_COMPONENTS STATIC) # Tasmanian::Tasmanian is static
find_package(... <no SHARED/STATIC component specified>) # Tasmanian::Tasmanian is static
```
```

### Known Issues

Several known issues and work-around fixes:
* The addon tests sometime fail due to thread scheduling
* The overhead associated with thread scheduling is much larger than the simple test models used,
which leads to unrealistically large fluctuations in sample run-time, which in turn leads to
randomness in the results, most notably on machines with few cpu cores.
* Rerun the tests and/or installation to see if the problem is persistent
* The GNU Make script sometimes fails under MacOSX because of security policies related to `rpath`
* use either the `install` script or CMake
* the CMake GUI works under MaxOSX and Linux the same way as Windows
* Mixing the GCC and Clang compilers and linkers sometimes fails with an error about the architecture
* use shared libraries only, i.e., `-D BUILD_SHARED_LIBS=ON` in CMake
* The PGI compiler fails when using optimization `-O2` with an error about an empty `free()`
* the bug happens when `std::vector<double>::resize()` is called on an empty vector
* use the `-O1` instead, this issue needs further investigation
* Older versions of CUDA do not work with newer versions of some compilers, e.g., gcc
* consult the CUDA manual for a list of acceptable compilers
4 changes: 2 additions & 2 deletions Doxygen/InterfacePython.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,8 @@ accessed with the Python `help()` function, e.g.,
```
* Addon module methods and C++ equivalent:
```
Tasmanian.loadNeededPoints -> TasGrid::loadNeededPoints <overwrite_loaded=false>
Tasmanian.reloadLoadedPoints -> TasGrid::loadNeededPoints <overwrite_loaded=true>
Tasmanian.loadNeededPoints -> TasGrid::loadNeededPoints <overwrite_loaded=false>
Tasmanian.reloadLoadedPoints -> TasGrid::loadNeededPoints <overwrite_loaded=true>
Tasmanian.constructAnisotropicSurrogate -> TasGrid::constructSurrogate (anistropic overload)
Tasmanian.constructSurplusSurrogate -> TasGrid::constructSurrogate (surplus overload)
```
Expand Down
2 changes: 1 addition & 1 deletion Doxygen/tasmanian.css
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,7 @@ tr[class^="separator:"] {

div.fragment {
border-radius: 5px;
padding: 1em;
padding: 0.5em;
}

div.line {
Expand Down

0 comments on commit 652523c

Please sign in to comment.