Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add DOI to README and docs #64

Merged
merged 2 commits into from
Nov 1, 2024
Merged

Add DOI to README and docs #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e4a75fc
Add DOI to README and docs
sloede Oct 21, 2024
0884730
Different bibtex id
sloede Oct 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -92,12 +92,12 @@ 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},
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
Expand Down
16 changes: 16 additions & 0 deletions docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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{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},
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).
Expand Down
Loading