From c4c6316208d45f5e43714097eed6180568a196cd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Syver=20D=C3=B8ving=20Agdestein?= Date: Mon, 18 Nov 2024 20:15:01 +0100 Subject: [PATCH 1/3] docs: add citation file --- CITATION.cff | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 CITATION.cff diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 000000000..294bef371 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,25 @@ +cff-version: 1.2.0 +title: IncompressibleNavierStokes.jl +message: >- + If you use this software, please cite it using the + metadata from this file. +type: software +authors: + - given-names: Syver Døving + family-names: Agdestein + affiliation: Centrum Wiskunde & Informatica + orcid: 'https://orcid.org/0000-0002-1589-2916' + - given-names: "Benjamin" + family-names: "Sanderse" + affiliation: Centrum Wiskunde & Informatica + orcid: "https://orcid.org/0000-0001-9483-1988" +repository-code: 'https://github.com/agdestein/IncompressibleNavierStokes.jl' +url: 'https://agdestein.github.io/IncompressibleNavierStokes.jl/' +abstract: >- + Incompressible Navier-Stokes solver written in + Julia, running on GPUs and compatible with + reverse mode automatic differentiation. +license: MIT +commit: 81c57ed9a4b366c2192610268564e8dfa26b43c8 +version: 2.0.1 +date-released: '2024-11-09' From 3f49b62f354be6b18fc382b276b6da44c391a3e1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Syver=20D=C3=B8ving=20Agdestein?= Date: Mon, 18 Nov 2024 20:22:27 +0100 Subject: [PATCH 2/3] docs: update citing page --- docs/src/about/citing.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/src/about/citing.md b/docs/src/about/citing.md index fa6b8492b..a823a497d 100644 --- a/docs/src/about/citing.md +++ b/docs/src/about/citing.md @@ -1 +1,7 @@ # Citing + +See the +[`CITATION.cff`](https://github.com/agdestein/IncompressibleNavierStokes.jl/blob/main/README.md) +file in the root of the repository for citation information. +To get the citation in BibTeX format, click on "Cite this repository"-button to the right on the +[GitHub landing page](https://github.com/agdestein/IncompressibleNavierStokes.jl). From 7593bdf16c8cc537a16723a87429c7cecc9fca88 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Syver=20D=C3=B8ving=20Agdestein?= Date: Mon, 18 Nov 2024 20:23:09 +0100 Subject: [PATCH 3/3] chore: add PR template --- .github/PULL_REQUEST_TEMPLATE.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..d72e4a4b4 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,3 @@ +## Checklist + +- [ ] I have added my name to the [`CITATION.cff` file](https://github.com/agdestein/IncompressibleNavierStokes.jl/blob/main/README.md).