-
Notifications
You must be signed in to change notification settings - Fork 87
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: Marcel Koch <[email protected]> Co-authored-by: Yu-Hsiang Tsai <[email protected]> Co-authored-by: Gregor Olenik <[email protected]>
- Loading branch information
4 people
committed
Dec 12, 2023
1 parent
eafe2c3
commit e67bc0b
Showing
1 changed file
with
30 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,43 +2,37 @@ | |
|
|
||
| <div align="center"> | ||
|
|
||
| License|C++ Standard|Documentation|JOSS paper | ||
| :--:|:--:|:--:|:--: | ||
| [](./LICENSE)|[](https://en.wikipedia.org/wiki/C%2B%2B#Standardization)|[](https://ginkgo-project.github.io/ginkgo-generated-documentation/doc/develop/)|[](https://doi.org/10.21105/joss.02260) | ||
| |:-:|:-:|:-:|:-:| | ||
|
|
||
|
|
||
| CI builds|Coverage| Maintainability|Reliability|Dashboard | ||
| :--:|:--:|:--:|:--:|:--: | ||
| [](https://github.com/ginkgo-project/ginkgo/commits/develop)[](https://github.com/ginkgo-project/ginkgo/actions/workflows/osx.yml)[](https://github.com/ginkgo-project/ginkgo/actions/workflows/windows-msvc-ref.yml)|[](https://codecov.io/gh/ginkgo-project/ginkgo)|[](https://sonarcloud.io/dashboard?id=ginkgo-project_ginkgo)|[](https://sonarcloud.io/dashboard?id=ginkgo-project_ginkgo)|[](https://my.cdash.org/index.php?project=Ginkgo+Project) | ||
| [](https://gitlab.com/ginkgo-project/ginkgo-public-ci/-/pipelines?page=1&scope=branches&ref=develop)|[](https://github.com/ginkgo-project/ginkgo/actions/workflows/osx.yml)|[](https://github.com/ginkgo-project/ginkgo/actions/workflows/windows-msvc-ref.yml) | ||
| |:-:|:-:|:-:| | ||
|
|
||
|
|
||
| [](https://codecov.io/gh/ginkgo-project/ginkgo)|[](https://sonarcloud.io/dashboard?id=ginkgo-project_ginkgo)|[](https://sonarcloud.io/dashboard?id=ginkgo-project_ginkgo)|[](https://my.cdash.org/index.php?project=Ginkgo+Project) | ||
| |:-:|:-:|:-:|:-:| | ||
|
|
||
| </div> | ||
|
|
||
|
|
||
| Ginkgo is a high-performance numerical linear algebra library for many-core systems, with a | ||
| focus on solution of sparse linear systems. It is implemented using modern C++ | ||
| (you will need an at least C++14 compliant compiler to build it), with GPU kernels | ||
| implemented for NVIDIA, AMD and Intel GPUs. | ||
|
|
||
| Table of Contents | ||
| ----------- | ||
| --- | ||
|
|
||
| * [Prerequisites](#prerequisites) | ||
| * [Linux and Mac OS](#linux-and-mac-os) | ||
| * [Windows](#windows) | ||
| * [Building and Installing Ginkgo](#building-and-installing-ginkgo) | ||
| * [Tests, Examples and Benchmarks](#testing-examples-and-benchmarks) | ||
| * [Testing](#testing) | ||
| * [Running Examples](#running-examples) | ||
| * [Benchmarking](#benchmarking) | ||
| * [Bug reports and support](#bug-reports-and-support) | ||
| * [Licensing](#licensing) | ||
| * [Contributing to Ginkgo](#contributing-to-ginkgo) | ||
| * [Declaration](#declaration) | ||
| * [Contribution Guidelines](#contribution-guidelines) | ||
| * [Citing Ginkgo](#citing-ginkgo) | ||
| **[Prerequisites](#prerequisites)** | | ||
| **[Building Ginkgo](#building-and-installing-ginkgo)** | | ||
| **[Tests, Examples, Benchmarks](#tests-examples-and-benchmarks)** | | ||
| **[Bug reports](#bug-reports-and-support)** | | ||
| **[Licensing](#licensing)** | | ||
| **[Contributing](#contributing-to-ginkgo)** | | ||
| **[Citing](#citing-ginkgo)** | ||
|
|
||
|
|
||
| Prerequisites | ||
| ------------- | ||
| # Prerequisites | ||
|
|
||
| ### Linux and Mac OS | ||
|
|
||
|
|
@@ -116,15 +110,14 @@ In these environments, two problems can be encountered, the solution for which i | |
| __NOTE:__ Some restrictions will also apply on the version of C and C++ standard | ||
| libraries installed on the system. This needs further investigation. | ||
|
|
||
| Building and Installing Ginkgo | ||
| --------------------------------- | ||
| # Building and Installing Ginkgo | ||
|
|
||
| To build Ginkgo, you can use the standard CMake procedure. | ||
|
|
||
| ```sh | ||
| mkdir build; cd build | ||
| cmake -G "Unix Makefiles" .. && make | ||
| make install # will install to the system default location | ||
| cmake -G "Unix Makefiles" .. && cmake --build . | ||
| cmake --install . | ||
| ``` | ||
|
|
||
| By default, `GINKGO_BUILD_REFERENCE` is enabled. You should be able to run | ||
|
|
@@ -135,11 +128,10 @@ run the examples with these executors. | |
|
|
||
| Please refer to the [Installation page](./INSTALL.md) for more details. | ||
|
|
||
| Tip: After installation, in your CMake project, Ginkgo can be added with `find_package(Ginkgo)`. | ||
| Tip: After installation, in your CMake project, Ginkgo can be added with `find_package(Ginkgo)` and the the target that is exported is `Ginkgo::ginkgo`. | ||
| An example can be found in the [`test_install`](test/test_install/CMakeLists.txt). | ||
|
|
||
| Tests, Examples and Benchmarks | ||
| ----------------------------------- | ||
| # Tests, Examples and Benchmarks | ||
|
|
||
| ### Testing | ||
|
|
||
|
|
@@ -156,18 +148,16 @@ with the help of the [Ginkgo Performance Explorer (GPE)](https://ginkgo-project. | |
|
|
||
| More details about this can be found in the [BENCHMARKING.md page](./BENCHMARKING.md) | ||
|
|
||
| Bug reports and Support | ||
| ------------------------- | ||
| # Bug reports and Support | ||
|
|
||
| If you have any questions about using Ginkgo, please use [Github discussions](https://github.com/ginkgo-project/ginkgo/discussions). | ||
|
|
||
| If you would like to request a feature, or have encountered a bug, please [create an | ||
| issue](https://github.com/ginkgo-project/ginkgo/issues/new). Please be sure to describe your problem and provide as much information as possible. | ||
|
|
||
| You can also send an email to [Ginkgo's main email address](mailto:[email protected]) or to contact any of the main [contributors](contributors.txt). | ||
| You can also send an email to [Ginkgo's main email address](mailto:[email protected]). | ||
|
|
||
| Licensing | ||
| ---------- | ||
| # Licensing | ||
|
|
||
| Ginkgo is available under the [3-clause BSD license](LICENSE). All contributions | ||
| to the project are added under this license. | ||
|
|
@@ -177,10 +167,11 @@ software may be pulled as additional dependencies, which have their own | |
| licensing conditions. Refer to [ABOUT-LICENSING.md](ABOUT-LICENSING.md) for | ||
| details. | ||
|
|
||
| Contributing to Ginkgo | ||
| ------------------------- | ||
| # Contributing to Ginkgo | ||
|
|
||
| We are glad that that you would like to contribute to Ginkgo and we are happy to help you with any questions you may have. | ||
|
|
||
| We are glad that that you would like to contribute to Ginkgo! If you are contributing for the first time, please add yourself to the list of external contributors with the following info | ||
| If you are contributing for the first time, please add yourself to the list of external contributors with the following info | ||
|
|
||
| ``` text | ||
| Name Surname <email@domain> Institution(s) | ||
|
|
@@ -203,8 +194,7 @@ When contributing to Ginkgo, to ease the review process, please follow the guide | |
| It also contains other general recommendations such as writing proper commit messages, understanding Ginkgo's library design, relevant C++ information etc. | ||
|
|
||
|
|
||
| Citing Ginkgo | ||
| --------------- | ||
| # Citing Ginkgo | ||
|
|
||
| The main Ginkgo paper describing Ginkgo's purpose, design and interface is | ||
| available through the following reference: | ||
|
|
||