Skip to content

Commit be97ae1

Browse files
Add JOSS paper to README and CITATION.cff
1 parent 6d4ca4a commit be97ae1

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

CITATION.cff

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
cff-version: 1.2.0
2+
message: "If you use this software, please it as below."
3+
authors:
4+
- family-names: "Bosch"
5+
given-names: "Nathanael"
6+
orcid: "https://orcid.org/0000-0003-0139-4622"
7+
title: 'ProbNumDiffEq.jl: Probabilistic Numerical Solvers for Ordinary Differential Equations in Julia'
8+
version: 0.16.2
9+
doi: 10.21105/joss.07048
10+
date-released: '2024-10-01'
11+
url: https://doi.org/10.21105/joss.07048

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
[![Build Status](https://github.com/nathanaelbosch/ProbNumDiffEq.jl/workflows/CI/badge.svg)](https://github.com/nathanaelbosch/ProbNumDiffEq.jl/actions)
66
[![Coverage](https://codecov.io/gh/nathanaelbosch/ProbNumDiffEq.jl/branch/main/graph/badge.svg?token=eufIemCGXn)](https://codecov.io/gh/nathanaelbosch/ProbNumDiffEq.jl)
77
[![Benchmarks](http://img.shields.io/badge/benchmarks-docs-blueviolet.svg)](https://nathanaelbosch.github.io/ProbNumDiffEq.jl/dev/benchmarks/multi-language-wrappers/)
8+
[![DOI](https://joss.theoj.org/papers/10.21105/joss.07048/status.svg)](https://doi.org/10.21105/joss.07048)
89

910
![Banner](./examples/banner.svg?raw=true)
1011

@@ -75,6 +76,26 @@ If there is anything that's unclear or doesn't work, we would very much like to
7576
This includes not just bugs and feature requests but also general questions about the software, feedback and suggestions.
7677

7778

79+
## Citing ProbNumDiffEq.jl
80+
81+
If you use ProbNumDiffEq.jl helpful for your research project, please cite our JOSS paper ([link](https://doi.org/10.21105/joss.07048)):
82+
```
83+
@article{Bosch2024,
84+
doi = {10.21105/joss.07048},
85+
url = {https://doi.org/10.21105/joss.07048},
86+
year = 2024,
87+
publisher = {The Open Journal},
88+
volume = 9,
89+
number = 101,
90+
pages = 7048,
91+
author = {Nathanael Bosch},
92+
title = {ProbNumDiffEq.jl: Probabilistic Numerical Solvers for Ordinary
93+
Differential Equations in Julia},
94+
journal = {Journal of Open Source Software}
95+
}
96+
```
97+
98+
7899
## Related packages
79100

80101
- [ProbDiffEq](https://pnkraemer.github.io/probdiffeq/) is similar in scope to ProbNumDiffEq.jl and it provides fast and feature-rich probabilistic ODE solvers but is implemented in Python and built on JAX.

0 commit comments

Comments
 (0)