From e4a75fc9ba08f7b4fba5120bfbf8bc375277e918 Mon Sep 17 00:00:00 2001 From: Michael Schlottke-Lakemper Date: Mon, 21 Oct 2024 07:37:22 +0200 Subject: [PATCH 1/2] Add DOI to README and docs --- README.md | 4 ++-- docs/src/index.md | 16 ++++++++++++++++ 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5275cf11..4fd3c170 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ [![Build Status](https://github.com/trixi-framework/HOHQMesh.jl/workflows/CI/badge.svg)](https://github.com/trixi-framework/HOHQMesh.jl/actions?query=workflow%3ACI) [![Coveralls](https://coveralls.io/repos/github/trixi-framework/HOHQMesh.jl/badge.svg?branch=main)](https://coveralls.io/github/trixi-framework/HOHQMesh.jl?branch=main) [![License: MIT](https://img.shields.io/badge/License-MIT-success.svg)](https://opensource.org/licenses/MIT) -[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.TODO.svg)](https://doi.org/10.5281/zenodo.TODO) +[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13959071.svg)](https://doi.org/10.5281/zenodo.13959071) This package is a Julia frontend to the Fortran-based *High Order Hex-Quad Mesher* (a.k.a. [**HOHQMesh**](https://github.com/trixi-framework/HOHQMesh)) created and developed by @@ -97,7 +97,7 @@ If you use HOHQMesh.jl in your own research, please cite this repository as foll author={Kopriva, David A and Winters, Andrew R and Schlottke-Lakemper, Michael and Ranocha, Hendrik}, year={2024}, howpublished={\url{https://github.com/trixi-framework/HOHQMesh.jl}}, - doi={10.5281/zenodo.TODO} + doi={10.5281/zenodo.13959071} } ``` Please also consider citing [HOHQMesh](https://github.com/trixi-framework/HOHQMesh) itself (see diff --git a/docs/src/index.md b/docs/src/index.md index 0a64ad34..7d93e36b 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -89,6 +89,22 @@ files that are saved and the output of mesh statistics to the screen. Further explanation of the interactive functionality can be found [here](@ref InteractiveTool). Additional examples are available in the [Tutorials](@ref). + +## Referencing +If you use HOHQMesh.jl in your own research, please cite this repository as follows: +```bibtex +@misc{kopriva2024hohqmesh, + title={{HOHQM}esh.jl: A Julia frontend to the Fortran-based HOHQMesh mesh generator for high order elements}, + author={Kopriva, David A and Winters, Andrew R and Schlottke-Lakemper, Michael and Ranocha, Hendrik}, + year={2024}, + howpublished={\url{https://github.com/trixi-framework/HOHQMesh.jl}}, + doi={10.5281/zenodo.13959071} +} +``` +Please also consider citing [HOHQMesh](https://github.com/trixi-framework/HOHQMesh) itself (see +[here](https://github.com/trixi-framework/HOHQMesh#referencing) for details on how to do this). + + ## [Authors](@id authors-index-md) HOHQMesh.jl is maintained by the [Trixi authors](https://github.com/trixi-framework/Trixi.jl/blob/main/AUTHORS.md). From 0884730d19ccbc24fe2691b95eb320b1876c04fd Mon Sep 17 00:00:00 2001 From: Michael Schlottke-Lakemper Date: Mon, 21 Oct 2024 07:42:32 +0200 Subject: [PATCH 2/2] Different bibtex id --- README.md | 2 +- docs/src/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4fd3c170..177645f2 100644 --- a/README.md +++ b/README.md @@ -92,7 +92,7 @@ Additional examples are available in the [Tutorials](https://trixi-framework.git ## Referencing If you use HOHQMesh.jl in your own research, please cite this repository as follows: ```bibtex -@misc{kopriva2024hohqmesh, +@misc{kopriva2024hohqmeshjl, title={{HOHQM}esh.jl: A Julia frontend to the Fortran-based HOHQMesh mesh generator for high order elements}, author={Kopriva, David A and Winters, Andrew R and Schlottke-Lakemper, Michael and Ranocha, Hendrik}, year={2024}, diff --git a/docs/src/index.md b/docs/src/index.md index 7d93e36b..c3f3258a 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -93,7 +93,7 @@ Additional examples are available in the [Tutorials](@ref). ## Referencing If you use HOHQMesh.jl in your own research, please cite this repository as follows: ```bibtex -@misc{kopriva2024hohqmesh, +@misc{kopriva2024hohqmeshjl, title={{HOHQM}esh.jl: A Julia frontend to the Fortran-based HOHQMesh mesh generator for high order elements}, author={Kopriva, David A and Winters, Andrew R and Schlottke-Lakemper, Michael and Ranocha, Hendrik}, year={2024},