Skip to content

Commit b9bec82

Browse files
authored
Merge Release v1.1.0
The Ginkgo team is proud to announce the new minor release of Ginkgo version 1.1.0. This release brings several performance improvements, adds Windows support, adds support for factorizations inside Ginkgo and a new ILU preconditioner based on ParILU algorithm, among other things. For detailed information, check the respective issue. Supported systems and requirements: + For all platforms, cmake 3.9+ + Linux and MacOS + gcc: 5.3+, 6.3+, 7.3+, 8.1+ + clang: 3.9+ + Intel compiler: 2017+ + Apple LLVM: 8.0+ + CUDA module: CUDA 9.0+ + Windows + MinGW and CygWin: gcc 5.3+, 6.3+, 7.3+, 8.1+ + Microsoft Visual Studio: VS 2017 15.7+ + CUDA module: CUDA 9.0+, Microsoft Visual Studio + OpenMP module: MinGW or CygWin. The current known issues can be found in the [known issues page](https://github.com/ginkgo-project/ginkgo/wiki/Known-Issues). Additions: + Upper and lower triangular solvers ([#327](#327), [#336](#336), [#341](#341), [#342](#342)) + New factorization support in Ginkgo, and addition of the ParILU algorithm ([#305](#305), [#315](#315), [#319](#319), [#324](#324)) + New ILU preconditioner ([#348](#348), [#353](#353)) + Windows MinGW and Cygwin support ([#347](#347)) + Windows Visual studio support ([#351](#351)) + New example showing how to use ParILU as a preconditioner ([#358](#358)) + New example on using loggers for debugging ([#360](#360)) + Add two new 9pt and 27pt stencil examples ([#300](#300), [#306](#306)) + Allow benchmarking CuSPARSE spmv formats through Ginkgo's benchmarks ([#303](#303)) + New benchmark for sparse matrix format conversions ([#312](https://github.com/ginkgo-project/ginkgo/issues/312)[#317](https://github.com/ginkgo-project/ginkgo/issues/317)) + Add conversions between CSR and Hybrid formats ([#302](#302), [#310](#310)) + Support for sorting rows in the CSR format by column idices ([#322](#322)) + Addition of a CUDA COO SpMM kernel for improved performance ([#345](#345)) + Addition of a LinOp to handle perturbations of the form (identity + scalar * basis * projector) ([#334](#334)) + New sparsity matrix representation format with Reference and OpenMP kernels ([#349](#349), [#350](#350)) Fixes: + Accelerate GMRES solver for CUDA executor ([#363](#363)) + Fix BiCGSTAB solver convergence ([#359](#359)) + Fix CGS logging by reporting the residual for every sub iteration ([#328](#328)) + Fix CSR,Dense->Sellp conversion's memory access violation ([#295](#295)) + Accelerate CSR->Ell,Hybrid conversions on CUDA ([#313](#313), [#318](#318)) + Fixed slowdown of COO SpMV on OpenMP ([#340](#340)) + Fix gcc 6.4.0 internal compiler error ([#316](#316)) + Fix compilation issue on Apple clang++ 10 ([#322](#322)) + Make Ginkgo able to compile on Intel 2017 and above ([#337](#337)) + Make the benchmarks spmv/solver use the same matrix formats ([#366](#366)) + Fix self-written isfinite function ([#348](#348)) + Fix Jacobi issues shown by cuda-memcheck Tools and ecosystem: + Multiple improvements to the CI system and tools ([#296](#296), [#311](#311), [#365](#365)) + Multiple improvements to the Ginkgo containers ([#328](#328), [#361](#361)) + Add sonarqube analysis to Ginkgo ([#304](#304), [#308](#308), [#309](#309)) + Add clang-tidy and iwyu support to Ginkgo ([#298](#298)) + Improve Ginkgo's support of xSDK M12 policy by adding the `TPL_` arguments to CMake ([#300](#300)) + Add support for the xSDK R7 policy ([#325](#325)) + Fix examples in html documentation ([#367](#367))
2 parents 4524464 + c217c76 commit b9bec82

File tree

292 files changed

+41877
-2894
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

292 files changed

+41877
-2894
lines changed

.gitlab-ci.yml

Lines changed: 312 additions & 163 deletions
Large diffs are not rendered by default.

CHANGELOG.md

Lines changed: 292 additions & 0 deletions
Large diffs are not rendered by default.

CMakeLists.txt

Lines changed: 68 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,9 @@
11
cmake_minimum_required(VERSION 3.9)
22

3-
project(Ginkgo LANGUAGES C CXX VERSION 1.0.0 DESCRIPTION "A numerical linear algebra library targeting many-core architectures")
3+
project(Ginkgo LANGUAGES C CXX VERSION 1.1.0 DESCRIPTION "A numerical linear algebra library targeting many-core architectures")
44
set(Ginkgo_VERSION_TAG "master")
55
set(PROJECT_VERSION_TAG ${Ginkgo_VERSION_TAG})
66

7-
# Load CMake helpers and modules
8-
include(cmake/build_helpers.cmake)
9-
include(cmake/create_test.cmake)
10-
include(cmake/install_helpers.cmake)
11-
set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake/Modules/")
12-
13-
include(cmake/build_type_helpers.cmake)
14-
157
# Ginkgo configuration options
168
option(GINKGO_DEVEL_TOOLS "Add development tools to the build system" ON)
179
option(GINKGO_BUILD_TESTS "Generate build files for unit tests" ON)
@@ -22,21 +14,41 @@ option(GINKGO_BUILD_OMP "Compile OpenMP kernels for CPU" OFF)
2214
option(GINKGO_BUILD_CUDA "Compile kernels for NVIDIA GPUs" OFF)
2315
option(GINKGO_BUILD_DOC "Generate documentation" OFF)
2416
option(GINKGO_SKIP_DEPENDENCY_UPDATE
25-
"Do not update dependencies each time the project is rebuilt" ON)
17+
"Do not update dependencies each time the project is rebuilt" ON)
2618
option(GINKGO_EXPORT_BUILD_DIR
2719
"Make Ginkgo export its build directory to the CMake package registry."
2820
OFF)
21+
option(GINKGO_WITH_CLANG_TIDY "Make Ginkgo call `clang-tidy` to find programming issues." OFF)
22+
option(GINKGO_WITH_IWYU "Make Ginkgo call `iwyu` (Include What You Use) to find include issues." OFF)
2923
set(GINKGO_VERBOSE_LEVEL "1" CACHE STRING
30-
"Verbosity level. Put 0 to turn off. 1 activates a few important messages.")
31-
set(GINKGO_COMPILER_FLAGS "-Wpedantic" CACHE STRING
32-
"Set the required CXX compiler flags, mainly used for warnings. Current default is `-Wpedantic`")
24+
"Verbosity level. Put 0 to turn off. 1 activates a few important messages.")
25+
if(MSVC)
26+
set(GINKGO_COMPILER_FLAGS "" CACHE STRING
27+
"Set the required CXX compiler flags, mainly used for warnings. Current default is ``")
28+
else()
29+
set(GINKGO_COMPILER_FLAGS "-Wpedantic" CACHE STRING
30+
"Set the required CXX compiler flags, mainly used for warnings. Current default is `-Wpedantic`")
31+
endif()
3332
set(GINKGO_CUDA_COMPILER_FLAGS "" CACHE STRING
34-
"Set the required NVCC compiler flags, mainly used for warnings. Current default is an empty string")
33+
"Set the required NVCC compiler flags, mainly used for warnings. Current default is an empty string")
3534
set(GINKGO_CUDA_ARCHITECTURES "Auto" CACHE STRING
3635
"A list of target NVIDIA GPU achitectures. See README.md for more detail.")
36+
option(GINKGO_CUDA_DEFAULT_HOST_COMPILER "Tell Ginkgo to not automatically set the CUDA host compiler" OFF)
3737
option(GINKGO_JACOBI_FULL_OPTIMIZATIONS "Use all the optimizations for the CUDA Jacobi algorithm" OFF)
3838
option(BUILD_SHARED_LIBS "Build shared (.so, .dylib, .dll) libraries" ON)
3939

40+
if(BUILD_SHARED_LIBS AND (WIN32 OR CYGWIN) AND (GINKGO_BUILD_TESTS OR GINKGO_BUILD_EXAMPLES OR GINKGO_BUILD_BENCHMARKS))
41+
# Change shared libraries output only if this build has executable program with shared libraries.
42+
set(GINKGO_CHANGED_SHARED_LIBRARY TRUE)
43+
option(GINKGO_CHECK_PATH "Tell Ginkgo to check if the environment variable PATH is available for this build." ON)
44+
set(GINKGO_WINDOWS_SHARED_LIBRARY_RELPATH "windows_shared_library" CACHE STRING
45+
"Set Ginkgo's shared library relative path in windows. Current default is `windows_shared_library`. \
46+
This absoulte path ${PROJECT_BINARY_DIR}/GINKGO_WINDOWS_SHARED_LIBRARY_RELPATH must be in the environment variable PATH.")
47+
set(GINKGO_WINDOWS_SHARED_LIBRARY_PATH ${PROJECT_BINARY_DIR}/${GINKGO_WINDOWS_SHARED_LIBRARY_RELPATH})
48+
else()
49+
set(GINKGO_CHANGED_SHARED_LIBRARY FALSE)
50+
endif()
51+
4052
if(GINKGO_BUILD_TESTS AND (GINKGO_BUILD_CUDA OR GINKGO_BUILD_OMP))
4153
message(STATUS "GINKGO_BUILD_TESTS is ON, enabling GINKGO_BUILD_REFERENCE")
4254
set(GINKGO_BUILD_REFERENCE ON CACHE BOOL "Compile reference CPU kernels" FORCE)
@@ -49,7 +61,7 @@ endif()
4961

5062
# Ensure we have a debug postfix
5163
if(NOT DEFINED CMAKE_DEBUG_POSTFIX)
52-
set(CMAKE_DEBUG_POSTFIX "d")
64+
set(CMAKE_DEBUG_POSTFIX "d")
5365
endif()
5466

5567
if(GINKGO_BUILD_TESTS)
@@ -58,10 +70,29 @@ if(GINKGO_BUILD_TESTS)
5870
${CMAKE_CURRENT_LIST_DIR}/cmake/CTestCustom.cmake.in
5971
${CMAKE_CURRENT_BINARY_DIR}/CTestCustom.cmake @ONLY)
6072

73+
# For testing, we need some special matrices
74+
add_subdirectory(matrices)
75+
6176
enable_testing()
6277
include(CTest)
6378
endif()
6479

80+
if (GINKGO_WITH_CLANG_TIDY)
81+
find_program(GINKGO_CLANG_TIDY_PATH clang-tidy)
82+
endif()
83+
84+
if (GINKGO_WITH_IWYU)
85+
find_program(GINKGO_IWYU_PATH iwyu)
86+
endif()
87+
88+
89+
# Load CMake helpers and modules
90+
include(cmake/build_helpers.cmake)
91+
include(cmake/build_type_helpers.cmake)
92+
include(cmake/create_test.cmake)
93+
include(cmake/install_helpers.cmake)
94+
set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake/Modules/")
95+
6596

6697
# Find important header files, store the definitions in include/ginkgo/config.h.in
6798
# For details, see https://gitlab.kitware.com/cmake/community/wikis/doc/tutorials/How-To-Write-Platform-Checks
@@ -78,14 +109,27 @@ endif()
78109
configure_file(${Ginkgo_SOURCE_DIR}/include/ginkgo/config.hpp.in
79110
${Ginkgo_BINARY_DIR}/include/ginkgo/config.hpp @ONLY)
80111

112+
# This is modified from https://gitlab.kitware.com/cmake/community/wikis/FAQ#dynamic-replace
113+
if(MSVC)
114+
if(BUILD_SHARED_LIBS)
115+
ginkgo_switch_to_windows_dynamic("CXX")
116+
ginkgo_switch_to_windows_dynamic("C")
117+
set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS TRUE)
118+
else()
119+
ginkgo_switch_to_windows_static("CXX")
120+
ginkgo_switch_to_windows_static("C")
121+
set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS FALSE)
122+
endif()
123+
endif()
124+
81125
# Try to find the third party packages before using our subdirectories
82126
include(cmake/package_helpers.cmake)
83-
ginkgo_find_package(GTest 1.8.1)
84-
ginkgo_find_package(gflags 2.2.2)
85-
ginkgo_find_package(RapidJSON 1.1.0)
127+
ginkgo_find_package(GTest "GTest::GTest;GTest::Main" FALSE 1.8.1)
128+
ginkgo_find_package(gflags gflags FALSE 2.2.2)
129+
ginkgo_find_package(RapidJSON rapidjson TRUE 1.1.0)
86130
add_subdirectory(third_party) # Third-party tools and libraries
87131

88-
# Needs to be first in order for `CMAKE_CUDA_DEVICE_LINK_EXECUTABLE` to be
132+
# Needs to be first in order for `CMAKE_CUDA_DEVICE_LINK_EXECUTABLE` to be
89133
# propagated to the other parts of Ginkgo in case of building as static libraries
90134
if(GINKGO_BUILD_CUDA)
91135
add_subdirectory(cuda) # High-performance kernels for NVIDIA GPUs
@@ -116,9 +160,13 @@ if(GINKGO_DEVEL_TOOLS)
116160
endif()
117161

118162
# Generate the global `ginkgo/ginkgo.hpp` header with every call of make
119-
add_custom_target(generate_ginkgo_header ALL
163+
find_program(BASH bash)
164+
if(NOT "${BASH}" STREQUAL "BASH-NOTFOUND")
165+
add_custom_target(generate_ginkgo_header ALL
120166
COMMAND ${Ginkgo_SOURCE_DIR}/dev_tools/scripts/update_ginkgo_header.sh
121167
WORKING_DIRECTORY ${Ginkgo_SOURCE_DIR})
168+
endif()
169+
unset(BASH CACHE)
122170

123171

124172
# Installation

INSTALL.md

Lines changed: 44 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,23 @@ Use the standard cmake build procedure:
88
mkdir build; cd build
99
cmake -G "Unix Makefiles" [OPTIONS] .. && make
1010
```
11+
Use `cmake --build .` in some systems like MinGW or Microsoft Visual Studio which do not use `make`.
12+
13+
For Microsoft Visual Studio, use `cmake --build . --config <build_type>` to decide the build type. The possible options are `Debug`, `Release`, `RelWithDebInfo` and `MinSizeRel`.
14+
1115
Replace `[OPTIONS]` with desired cmake options for your build.
1216
Ginkgo adds the following additional switches to control what is being built:
1317

1418
* `-DGINKGO_DEVEL_TOOLS={ON, OFF}` sets up the build system for development
1519
(requires clang-format, will also download git-cmake-format),
16-
default is `ON`
20+
default is `ON`.
1721
* `-DGINKGO_BUILD_TESTS={ON, OFF}` builds Ginkgo's tests
18-
(will download googletest), default is `ON`
22+
(will download googletest), default is `ON`.
1923
* `-DGINKGO_BUILD_BENCHMARKS={ON, OFF}` builds Ginkgo's benchmarks
20-
(will download gflags and rapidjson), default is `ON`
24+
(will download gflags and rapidjson), default is `ON`.
2125
* `-DGINKGO_BUILD_EXAMPLES={ON, OFF}` builds Ginkgo's examples, default is `ON`
22-
* `-DGINKGO_BUILD_EXTLIB_EXAMPLE={ON, OFF}` builds the interfacing example with deal.II, default is `OFF`
26+
* `-DGINKGO_BUILD_EXTLIB_EXAMPLE={ON, OFF}` builds the interfacing example
27+
with deal.II, default is `OFF`.
2328
* `-DGINKGO_BUILD_REFERENCE={ON, OFF}` build reference implementations of the
2429
kernels, useful for testing, default is `ON`
2530
* `-DGINKGO_BUILD_OMP={ON, OFF}` builds optimized OpenMP versions of the kernels,
@@ -36,17 +41,23 @@ Ginkgo adds the following additional switches to control what is being built:
3641
Ginkgo's documentation. The default is `OFF`.
3742
* `-DGINKGO_EXPORT_BUILD_DIR={ON, OFF}` adds the Ginkgo build directory to the
3843
CMake package registry. The default is `OFF`.
44+
* `-DGINKGO_WITH_CLANG_TIDY={ON, OFF}` makes Ginkgo call `clang-tidy` to find
45+
programming issues. The path can be manually controlled with the CMake
46+
variable `-DGINKGO_CLANG_TIDY_PATH=<path>`. The default is `OFF`.
47+
* `-DGINKGO_WITH_IWYU={ON, OFF}` makes Ginkgo call `iwyu` to find include
48+
issues. The path can be manually controlled with the CMake variable
49+
`-DGINKGO_IWYU_PATH=<path>`. The default is `OFF`.
3950
* `-DGINKGO_VERBOSE_LEVEL=integer` sets the verbosity of Ginkgo.
4051
* `0` disables all output in the main libraries,
4152
* `1` enables a few important messages related to unexpected behavior (default).
4253
* `-DCMAKE_INSTALL_PREFIX=path` sets the installation path for `make install`.
43-
The default value is usually something like `/usr/local`
54+
The default value is usually something like `/usr/local`.
4455
* `-DCMAKE_BUILD_TYPE=type` specifies which configuration will be used for
4556
this build of Ginkgo. The default is `RELEASE`. Supported values are CMake's
4657
standard build types such as `DEBUG` and `RELEASE` and the Ginkgo specific
4758
`COVERAGE`, `ASAN` (AddressSanitizer) and `TSAN` (ThreadSanitizer) types.
4859
* `-DBUILD_SHARED_LIBS={ON, OFF}` builds ginkgo as shared libraries (`OFF`)
49-
or as dynamic libraries (`ON`), default is `ON`
60+
or as dynamic libraries (`ON`), default is `ON`.
5061
* `-DGINKGO_JACOBI_FULL_OPTIMIZATIONS={ON, OFF}` use all the optimizations
5162
for the CUDA Jacobi algorithm. `OFF` by default. Setting this option to `ON`
5263
may lead to very slow compile time (>20 minutes) for the
@@ -75,6 +86,14 @@ Ginkgo adds the following additional switches to control what is being built:
7586
this option see the
7687
[`ARCHITECTURES` specification list](https://github.com/ginkgo-project/CudaArchitectureSelector/blob/master/CudaArchitectureSelector.cmake#L58)
7788
section in the documentation of the CudaArchitectureSelector CMake module.
89+
* `-DGINKGO_WINDOWS_SHARED_LIBRARY_RELPATH=<path>` where <path> is a relative
90+
path built with `PROJECT_BINARY_DIR`. Users must add the absolute path
91+
(`PROJECT_BINARY_DIR`/`GINKGO_WINDOWS_SHARED_LIBRARY_RELPATH`) into the
92+
environment variable PATH when building shared libraries and executable
93+
program, default is `windows_shared_library`.
94+
* `-DGINKGO_CHECK_PATH={ON, OFF}` checks if the environment variable PATH is valid.
95+
It is checked only when building shared libraries and executable program,
96+
default is `ON`.
7897

7998
For example, to build everything (in debug mode), use:
8099

@@ -107,15 +126,27 @@ packages can be turned off by disabling the relevant options.
107126

108127
By default, Ginkgo uses the internal version of each package. For each of the
109128
packages `GTEST`, `GFLAGS`, `RAPIDJSON` and `CAS`, it is possible to force
110-
Ginkgo to try to use an external version of a package. For this, set the CMake
111-
option `-DGINKGO_USE_EXTERNAL_<package>=ON`.
112-
113-
If the external packages were not installed to the default location, the
114-
CMake option `-DCMAKE_PREFIX_PATH=<path-list>` needs to be set to the semicolon
115-
(`;`) separated list of install paths of these external packages. For more
116-
Information, see the [CMake documentation for CMAKE_PREFIX_PATH](https://cmake.org/cmake/help/v3.9/variable/CMAKE_PREFIX_PATH.html)
129+
Ginkgo to try to use an external version of a package. For this, Ginkgo provides
130+
two ways to find packages. To rely on the CMake `find_package` command, use the
131+
CMake option `-DGINKGO_USE_EXTERNAL_<package>=ON`. Note that, if the external
132+
packages were not installed to the default location, the CMake option
133+
`-DCMAKE_PREFIX_PATH=<path-list>` needs to be set to the semicolon (`;`)
134+
separated list of install paths of these external packages. For more
135+
Information, see the [CMake documentation for
136+
CMAKE_PREFIX_PATH](https://cmake.org/cmake/help/v3.9/variable/CMAKE_PREFIX_PATH.html)
117137
for details.
118138

139+
To manually configure the paths, Ginkgo relies on the [standard xSDK Installation
140+
policies](https://xsdk.info/policies/) for all packages except `CAS` (as it is
141+
neither a library nor a header, it cannot be expressed through the `TPL`
142+
format):
143+
+ `-DTPL_ENABLE_<package>=ON`
144+
+ `-DTPL_<package>_LIBRARIES=/path/to/libraries.{so|a}`
145+
+ `-DTPL_<package>_INCLUDE_DIRS=/path/to/header/directory`
146+
147+
When applicable (e.g. for `GTest` libraries), a `;` separated list can be given
148+
to the `TPL_<package>_{LIBRARIES|INCLUDE_DIRS}` variables.
149+
119150
### Installing Ginkgo
120151

121152
To install Ginkgo into the specified folder, execute the following command in

README.md

Lines changed: 36 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
![Ginkgo](/assets/logo.png)
22

33
[![Build status](https://gitlab.com/ginkgo-project/ginkgo-public-ci/badges/master/build.svg)](https://github.com/ginkgo-project/ginkgo/commits/master)
4-
[![Coverage](https://codecov.io/gh/ginkgo-project/ginkgo/branch/master/graph/badge.svg)](https://codecov.io/gh/ginkgo-project/ginkgo)
54
[![CDash dashboard](https://img.shields.io/badge/CDash-Access-blue.svg)](http://my.cdash.org/index.php?project=Ginkgo+Project)
65
[![Documentation](https://img.shields.io/badge/Documentation-latest-blue.svg)](https://ginkgo-project.github.io/ginkgo/doc/master/)
7-
[![License](https://img.shields.io/github/license/ginkgo-project/ginkgo.svg)](LICENSE)
6+
[![License](https://img.shields.io/github/license/ginkgo-project/ginkgo.svg)](./LICENSE)
87
[![c++ standard](https://img.shields.io/badge/c%2B%2B-11-blue.svg)](https://en.wikipedia.org/wiki/C%2B%2B#Standardization)
98

109
Ginkgo is a high-performance linear algebra library for manycore systems, with a
@@ -34,6 +33,7 @@ For Ginkgo core library:
3433
* C++11 compliant compiler, one of:
3534
* _gcc 5.3+, 6.3+, 7.3+, 8.1+_
3635
* _clang 3.9+_
36+
* _Intel compiler 2017+_
3737
* _Apple LLVM 8.0+_ (__TODO__: verify)
3838

3939
The Ginkgo CUDA module has the following __additional__ requirements:
@@ -48,13 +48,32 @@ In addition, if you want to contribute code to Ginkgo, you will also need the
4848
following:
4949

5050
* _clang-format 5.0.1+_ (ships as part of _clang_)
51+
* _clang-tidy_ (optional, when setting the flag `-DGINKGO_WITH_CLANG_TIDY=ON`)
52+
* _iwyu_ (Include What You Use, optional, when setting the flag `-DGINKGO_WITH_IWYU=ON`)
5153

5254
### Windows
5355

54-
Windows is currently not supported, but we are working on porting the library
55-
there. If you are interested in helping us with this effort, feel free to
56-
contact one of the developers. (The library itself doesn't use any non-standard
57-
C++ features, so most of the effort here is in modifying the build system.)
56+
The prequirement needs to be verified
57+
* _cmake 3.9+_
58+
* C++11 compliant 64-bits compiler:
59+
* _MinGW : gcc 5.3+, 6.3+, 7.3+, 8.1+_
60+
* _Cygwin : gcc 5.3+, 6.3+, 7.3+, 8.1+_
61+
* _Microsoft Visual Studio : VS 2017 15.7+_
62+
63+
__NOTE:__ Need to add `--autocrlf=input` after `git clone` in _Cygwin_.
64+
65+
The Ginkgo CUDA module has the following __additional__ requirements:
66+
67+
* _CUDA 9.0+_
68+
* _Microsoft Visual Studio_
69+
* Any host compiler restrictions your version of CUDA may impose also apply
70+
here. For the newest CUDA version, this information can be found in the
71+
[CUDA installation guide for Windows](https://docs.nvidia.com/cuda/cuda-installation-guide-microsoft-windows/index.html)
72+
73+
The Ginkgo OMP module has the following __additional__ requirements:
74+
* _MinGW_ or _Cygwin_
75+
76+
__NOTE:__ _Microsoft Visual Studio_ only supports OpenMP 2.0, so it can not compile the ginkgo OMP module.
5877

5978
__NOTE:__ Some restrictions will also apply on the version of C and C++ standard
6079
libraries installed on the system. This needs further investigation.
@@ -91,7 +110,7 @@ Ginkgo does comprehensive unit tests using Google Tests. These tests are enabled
91110
A unique feature of Ginkgo is the ability to run benchmarks and view your results
92111
with the help of the [Ginkgo Performance Explorer (GPE)](https://ginkgo-project.github.io/gpe/).
93112

94-
More details about this can be found in the [documentation](https://ginkgo-project.github.io/ginkgo/doc/master/)
113+
More details about this can be found in the [BENCHMARKING.md page](./BENCHMARKING.md)
95114

96115
Contributing to Ginkgo
97116
---------------------------
@@ -103,7 +122,7 @@ external contributors like in the example below.
103122

104123
#### Contributors
105124
I hereby place all my contributions in this codebase under a BSD-3-Clause
106-
license, as specified in the repository's [LICENSE](LICENSE) file.
125+
license, as specified in the repository's [LICENSE](./LICENSE) file.
107126

108127
Name Surname <email@domain> Institution(s)
109128

@@ -113,11 +132,16 @@ Contributing guidelines can be accessed in our Wiki under the [Developer's
113132
Homepage](https://github.com/ginkgo-project/ginkgo/wiki/Developers-Homepage).
114133
This page also contains other information useful to developers, such as writing
115134
proper commit messages, understanding Ginkgo's library design, relevant C++
116-
information, and more.
135+
information, and more. In general, always refer to this page for developer
136+
information.
137+
138+
### Support
139+
If you have any question, bug to report or would like to propose a new feature,
140+
feel free to [create an
141+
issue on GitHub](https://github.com/ginkgo-project/ginkgo/issues/new). Another possibility
142+
is to send an email to [Ginkgo's main email address](ginkgo.library@gmail.com)
143+
or to contact any of the main [contributors](contributors.txt).
117144

118-
In general, always refer to this page for developer information. If you think
119-
that anything is missing, feel free to [create an
120-
issue](https://github.com/ginkgo-project/ginkgo/issues/new).
121145

122146
### Licensing
123147

benchmark/CMakeLists.txt

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,22 @@ if (NOT CMAKE_BUILD_TYPE STREQUAL "Release")
44
"will be affected")
55
endif()
66

7+
function(ginkgo_benchmark_cusp_linops name)
8+
target_compile_definitions("${name}" PRIVATE HAS_CUDA=1)
9+
target_link_libraries("${name}" ginkgo ${CUDA_RUNTIME_LIBS}
10+
${CUBLAS} ${CUSPARSE})
11+
target_include_directories("${name}" SYSTEM PRIVATE ${CUDA_INCLUDE_DIRS})
12+
if(CMAKE_CUDA_COMPILER_VERSION GREATER_EQUAL "9.2")
13+
target_compile_definitions("${name}" PRIVATE ALLOWMP=1)
14+
endif()
15+
endfunction()
16+
17+
add_subdirectory(conversions)
718
add_subdirectory(matrix_generator)
819
add_subdirectory(matrix_statistics)
920
add_subdirectory(preconditioner)
1021
add_subdirectory(solver)
1122
add_subdirectory(spmv)
12-
add_subdirectory(spmv_comparison_cuda)
1323

1424
add_custom_target(make_run_all_benchmarks ALL)
1525
add_custom_command(

benchmark/conversions/CMakeLists.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
add_executable(conversions conversions.cpp)
2+
target_link_libraries(conversions ginkgo gflags rapidjson)

0 commit comments

Comments
 (0)