The JOSS paper. #479
Merged
The JOSS paper. #479
Conversation
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
pratikvn
added
1:ST:do-not-merge
pratikvn
requested review from
hartwiganzt,
tcojean,
thoasm,
upsj,
yhmtsai,
fritzgoebel,
gflegar and
yanjen
|
Do we need to keep JOSS paper each version or the latest version? |
|
No, just the current version should be enough, if we have sufficient changes, I guess we could submit another version or update the paper, but in general, I think they link back to the github repo, so we should be fine even if the version there is a bit old. Edit: We need to archive a version of Ginkgo on a site such as Zenodo, get DOI from that and submit that DOI to JOSS. The paper will then serve as a companion of sorts for the archive. |
|
I worked a little on the text. please review. |
hartwiganzt
approved these changes
Mar 25, 2020
yhmtsai
approved these changes
Mar 26, 2020
upsj
reviewed
Mar 26, 2020
|
I'm wondering here if we can/should add some figures, such as the class hierarchy or one or two figure on some performance results? The purpose in to not add a lot, but enough to provide a good understanding of some key aspects. |
|
@tcojean , yes we can. I dont see a paper limit (max number of pages I have seen in around 7-8) and we dont have a lot of pages. I guess you already have a class diagram ? |
|
Yes I have all of that. I had prepared something just in case, if you don't mind I'll post most of Tobias' corrections and some of these additions. |
|
I pushed some changes, feel free to review them. Some issues I'm working on:
|
tcojean
approved these changes
Mar 29, 2020
thoasm
reviewed
Mar 30, 2020
pratikvn
commented
Mar 30, 2020
upsj
approved these changes
Mar 31, 2020
pratikvn
commented
Apr 1, 2020
pratikvn
commented
Apr 1, 2020
+ Rebase and put this up to date + Add Tobias's corrections. + Mention Ginkgo is based on the central concept of linear operator. + Mention Ginkgo is also available as a spack package. + Add some figures to explain Ginkgo's design and performance.
Add Thomas' ORCID. Co-Authored-By: Thomas Grützmacher <[email protected]>
Specify SpMV performance results.
Co-Authored-By: Tobias Ribizel <[email protected]>
Co-Authored-By: Tobias Ribizel <[email protected]>
|
Kudos, SonarCloud Quality Gate passed!
|
tcojean
added a commit
that referenced
this pull request
Aug 26, 2020
Release 1.3.0 of Ginkgo. The Ginkgo team is proud to announce the new minor release of Ginkgo version 1.3.0. This release brings CUDA 11 support, changes the default C++ standard to be C++14 instead of C++11, adds a new Diagonal matrix format and capacity for diagonal extraction, significantly improves the CMake configuration output format, adds the Ginkgo paper which got accepted into the Journal of Open Source Software (JOSS), and fixes multiple issues. Supported systems and requirements: + For all platforms, cmake 3.9+ + Linux and MacOS + gcc: 5.3+, 6.3+, 7.3+, all versions after 8.1+ + clang: 3.9+ + Intel compiler: 2017+ + Apple LLVM: 8.0+ + CUDA module: CUDA 9.0+ + HIP module: ROCm 2.8+ + Windows + MinGW and Cygwin: gcc 5.3+, 6.3+, 7.3+, all versions after 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: + Add paper for Journal of Open Source Software (JOSS). [#479](#479) + Add a DiagonalExtractable interface. [#563](#563) + Add a new diagonal Matrix Format. [#580](#580) + Add Cuda11 support. [#603](#603) + Add information output after CMake configuration. [#610](#610) + Add a new preconditioner export example. [#595](#595) + Add a new cuda-memcheck CI job. [#592](#592) Changes: + Use unified memory in CUDA debug builds. [#621](#621) + Improve `BENCHMARKING.md` with more detailed info. [#619](#619) + Use C++14 standard instead of C++11. [#611](#611) + Update the Ampere sm information and CudaArchitectureSelector. [#588](#588) Fixes: + Fix documentation warnings and errors. [#624](#624) + Fix warnings for diagonal matrix format. [#622](#622) + Fix criterion factory parameters in CUDA. [#586](#586) + Fix the norm-type in the examples. [#612](#612) + Fix the WAW race in OpenMP is_sorted_by_column_index. [#617](#617) + Fix the example's exec_map by creating the executor only if requested. [#602](#602) + Fix some CMake warnings. [#614](#614) + Fix Windows building documentation. [#601](#601) + Warn when CXX and CUDA host compiler do not match. [#607](#607) + Fix reduce_add, prefix_sum, and doc-build. [#593](#593) + Fix find_library(cublas) issue on machines installing multiple cuda. [#591](#591) + Fix allocator in sellp read. [#589](#589) + Fix the CAS with HIP and NVIDIA backends. [#585](#585) Deletions: + Remove unused preconditioner parameter in LowerTrs. [#587](#587) Related PR: #625
tcojean
added a commit
that referenced
this pull request
Aug 27, 2020
The Ginkgo team is proud to announce the new minor release of Ginkgo version 1.3.0. This release brings CUDA 11 support, changes the default C++ standard to be C++14 instead of C++11, adds a new Diagonal matrix format and capacity for diagonal extraction, significantly improves the CMake configuration output format, adds the Ginkgo paper which got accepted into the Journal of Open Source Software (JOSS), and fixes multiple issues. Supported systems and requirements: + For all platforms, cmake 3.9+ + Linux and MacOS + gcc: 5.3+, 6.3+, 7.3+, all versions after 8.1+ + clang: 3.9+ + Intel compiler: 2017+ + Apple LLVM: 8.0+ + CUDA module: CUDA 9.0+ + HIP module: ROCm 2.8+ + Windows + MinGW and Cygwin: gcc 5.3+, 6.3+, 7.3+, all versions after 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: + Add paper for Journal of Open Source Software (JOSS). [#479](#479) + Add a DiagonalExtractable interface. [#563](#563) + Add a new diagonal Matrix Format. [#580](#580) + Add Cuda11 support. [#603](#603) + Add information output after CMake configuration. [#610](#610) + Add a new preconditioner export example. [#595](#595) + Add a new cuda-memcheck CI job. [#592](#592) Changes: + Use unified memory in CUDA debug builds. [#621](#621) + Improve `BENCHMARKING.md` with more detailed info. [#619](#619) + Use C++14 standard instead of C++11. [#611](#611) + Update the Ampere sm information and CudaArchitectureSelector. [#588](#588) Fixes: + Fix documentation warnings and errors. [#624](#624) + Fix warnings for diagonal matrix format. [#622](#622) + Fix criterion factory parameters in CUDA. [#586](#586) + Fix the norm-type in the examples. [#612](#612) + Fix the WAW race in OpenMP is_sorted_by_column_index. [#617](#617) + Fix the example's exec_map by creating the executor only if requested. [#602](#602) + Fix some CMake warnings. [#614](#614) + Fix Windows building documentation. [#601](#601) + Warn when CXX and CUDA host compiler do not match. [#607](#607) + Fix reduce_add, prefix_sum, and doc-build. [#593](#593) + Fix find_library(cublas) issue on machines installing multiple cuda. [#591](#591) + Fix allocator in sellp read. [#589](#589) + Fix the CAS with HIP and NVIDIA backends. [#585](#585) Deletions: + Remove unused preconditioner parameter in LowerTrs. [#587](#587) Related PR: #627
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Journal of Open Source Software is a journal where we can publish Ginkgo so that we can cite papers that use Ginkgo easily and clearly. Some Open Source softwares that have been published can be looked at on the JOSS webpage.
In this regard, to submit a paper there, a joss-paper branch has been created. Their requirement is to have a
paper.mdand apaper.bibfile which is in ourdoc/jossfolder.The github action should compile and spit out a pdf as an artifact for download and easy viewing.
The
codemeta.jsonfile is automatically generated file from their ruby script from my git repo. This an optional file that we can provide them with. As it has been automatically generated, it is incomplete.In general, the idea is to have a small summary of the features of Ginkgo and showcase the novel features it provides to the community. See the detailed requirements here.
You can also view how the final paper would look like here
Feel free to update any details you find incorrect and would like to change.
Things to do.
.mdfile.codemeta.jsonfile, OPTIONAL..gitlab_ci.ymland.github/workflows/*files.DO NOT MERGE until the paper has been accepted into JOSS.
Closes #478