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.

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 JOSS paper to README and add CITATION.cff #68

Merged
merged 1 commit into from
Dec 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
56 changes: 56 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
cff-version: "1.2.0"
authors:
- family-names: Kopriva
given-names: David A.
orcid: "https://orcid.org/0000-0002-8076-0856"
- family-names: Winters
given-names: Andrew R.
orcid: "https://orcid.org/0000-0002-5902-1522"
- family-names: Schlottke-Lakemper
given-names: Michael
orcid: "https://orcid.org/0000-0002-3195-2536"
- family-names: Schoonover
given-names: Joseph A.
orcid: "https://orcid.org/0000-0001-5650-7095"
- family-names: Ranocha
given-names: Hendrik
orcid: "https://orcid.org/0000-0002-3456-2277"
contact:
- family-names: Winters
given-names: Andrew R.
orcid: "https://orcid.org/0000-0002-5902-1522"
doi: 10.5281/zenodo.14342391
message: If you use this software, please cite our article in the
Journal of Open Source Software.
preferred-citation:
authors:
- family-names: Kopriva
given-names: David A.
orcid: "https://orcid.org/0000-0002-8076-0856"
- family-names: Winters
given-names: Andrew R.
orcid: "https://orcid.org/0000-0002-5902-1522"
- family-names: Schlottke-Lakemper
given-names: Michael
orcid: "https://orcid.org/0000-0002-3195-2536"
- family-names: Schoonover
given-names: Joseph A.
orcid: "https://orcid.org/0000-0001-5650-7095"
- family-names: Ranocha
given-names: Hendrik
orcid: "https://orcid.org/0000-0002-3456-2277"
date-published: 2024-12-11
doi: 10.21105/joss.07476
issn: 2475-9066
issue: 104
journal: Journal of Open Source Software
publisher:
name: Open Journals
start: 7476
title: "HOHQMesh: An All Quadrilateral/Hexahedral Unstructured Mesh
Generator for High Order Elements"
type: article
url: "https://joss.theoj.org/papers/10.21105/joss.07476"
volume: 9
title: "HOHQMesh: An All Quadrilateral/Hexahedral Unstructured Mesh
Generator for High Order Elements"
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,22 @@ 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:
If you use HOHQMesh.jl in your own research, please cite the following article:
```bibtex
@article{kopriva2024hohqmesh:joss,
title={{HOHQM}esh: An All Quadrilateral/Hexahedral Unstructured Mesh Generator for High Order Elements},
author={David A. Kopriva and Andrew R. Winters and Michael Schlottke-Lakemper
and Joseph A. Schoonover and Hendrik Ranocha},
year={2024},
journal={Journal of Open Source Software},
doi={10.21105/joss.07476},
volume = {9},
number = {104},
pages = {7476},
publisher = {The Open Journal}
}
```
In addition, you can also directly refer to this repository as
```bibtex
@misc{kopriva2024hohqmeshjl,
title={{HOHQM}esh.jl: A Julia frontend to the Fortran-based HOHQMesh mesh generator for high order elements},
Expand All @@ -100,8 +115,6 @@ If you use HOHQMesh.jl in your own research, please cite this repository as foll
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
Expand Down
Loading