Skip to content

Commit 6f73ebc

Browse files
authored
Zenodo -> JOSS (#193)
1 parent b094882 commit 6f73ebc

File tree

2 files changed

+46
-4
lines changed

2 files changed

+46
-4
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,29 @@ ax = Axis(fig[3, 3]; title = "Generic Clipped Voronoi", wh...); voronoiplot!(ax
129129

130130
![](readme.png)
131131

132+
## Citing DelaunayTriangulation.jl
133+
134+
If you use DelaunayTriangulation.jl, please cite it. There is a JOSS paper published at [https://doi.org/10.21105/joss.07174](https://doi.org/10.21105/joss.07174). The BibTeX entry for this paper is:
135+
136+
```bibtex
137+
@article{VandenHeuvel2024DelaunayTriangulation,
138+
author = {VandenHeuvel, Daniel J.},
139+
doi = {10.21105/joss.07174},
140+
journal = {Journal of Open Source Software},
141+
month = sep,
142+
number = {101},
143+
pages = {7174},
144+
title = {{DelaunayTriangulation.jl: A Julia package for Delaunay triangulations and Voronoi tessellations in the plane}},
145+
url = {https://joss.theoj.org/papers/10.21105/joss.07174},
146+
volume = {9},
147+
year = {2024}
148+
}
149+
```
150+
151+
## License
152+
153+
DelaunayTriangulation.jl is provided under a [MIT license](https://github.com/JuliaGeometry/DelaunayTriangulation.jl/blob/main/LICENSE).
154+
132155
## Similar Packages
133156

134157
This is not the only Delaunay triangulation package available. Some others are:

docs/src/index.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ This is a package for computing Delaunay triangulations and Voronoi tessellation
2323
To ensure that the algorithms are robust, by default we make use of [AdaptivePredicates.jl](https://github.com/JuliaGeometry/AdaptivePredicates.jl) to use
2424
adaptive arithmetic for all geometric predicates in this package. This choice can be configured, allowing for the additional choices of [ExactPredicates.jl](https://github.com/lairez/ExactPredicates.jl) or no adaptive or exact arithmetic at all; see [here](manual/predicate_kernels.md). Much of the work in this package is derived from the book [*Delaunay Mesh Generation* by Cheng, Dey, and Shewchuk (2013)](https://people.eecs.berkeley.edu/~jrs/meshbook.html).
2525

26+
If you would like to make an issue or contribute, please see the CONTRIBUTION.md file in the repository. For feature requests, please see the discussions tab.
27+
2628
# Documentation Structure
2729

2830
The documentation for this package is broken into several sections.
@@ -35,11 +37,9 @@ The documentation for this package is broken into several sections.
3537
- **Example Applications**: In case you want to use this package for some of your applications, it might be useful to see how it has been applied in certain situations. Only a few applications are considered here, but more could be added in the future.
3638
- **Terminology**: This section provides a short description of some of the terminology used throughout the package.
3739

38-
If you see anything missing in any of these sections, or anything you think could be improved, feel free to file an issue.
40+
If you would also like to see how DelaunayTriangulation.jl is used in other packages, see [FiniteVolumeMethod.jl](https://github.com/SciML/FiniteVolumeMethod.jl) (solving 2D PDEs) and [NaturalNeighbours.jl](https://github.com/DanielVandH/NaturalNeighbours.jl) (scattered data interpolation).
3941

40-
# Citing DelaunayTriangulation.jl
41-
42-
If you use DelaunayTriangulation.jl, please cite it. For now, we have a Zenodo record available at [10.5281/zenodo.7456989](https://doi.org/10.5281/zenodo.7456989).
42+
If you see anything missing in any of these sections, or anything you think could be improved, feel free to file an issue.
4343

4444
# Installation
4545

@@ -50,6 +50,25 @@ import Pkg
5050
Pkg.add("DelaunayTriangulation")
5151
```
5252

53+
# Citing DelaunayTriangulation.jl
54+
55+
If you use DelaunayTriangulation.jl, please cite it. There is a JOSS paper published at https://doi.org/10.21105/joss.0717. The BibTeX entry for this paper is:
56+
57+
```bibtex
58+
@article{VandenHeuvel2024DelaunayTriangulation,
59+
author = {VandenHeuvel, Daniel J.},
60+
doi = {10.21105/joss.07174},
61+
journal = {Journal of Open Source Software},
62+
month = sep,
63+
number = {101},
64+
pages = {7174},
65+
title = {{DelaunayTriangulation.jl: A Julia package for Delaunay triangulations and Voronoi tessellations in the plane}},
66+
url = {https://joss.theoj.org/papers/10.21105/joss.07174},
67+
volume = {9},
68+
year = {2024}
69+
}
70+
```
71+
5372
Alternatively, the Pkg REPL can be used (accessed by typing `]` at the `julia>` prompt):
5473

5574
```julia

0 commit comments

Comments
 (0)