Skip to content

Commit

Permalink
Add JOSS paper to README and CITATION.cff
Browse files Browse the repository at this point in the history
  • Loading branch information
nathanaelbosch committed Oct 1, 2024
1 parent 6d4ca4a commit c9174ed
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 0 deletions.
19 changes: 19 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
cff-version: 1.2.0
message: If you use this software, please cite both the article from preferred-citation and the software itself.
authors: []
title: 'ProbNumDiffEq.jl: Probabilistic Numerical Solvers for Ordinary Differential Equations in Julia'
version: 1.0.0
url: https://doi.org/10.21105/joss.07048
doi: 10.21105/joss.07048
date-released: '2024-10-01'
preferred-citation:
authors: []
title: 'ProbNumDiffEq.jl: Probabilistic Numerical Solvers for Ordinary Differential Equations in Julia'
doi: 10.21105/joss.07048
url: https://doi.org/10.21105/joss.07048
type: article-journal
pages: '7048'
year: '2024'
conference: {}
publisher:
name: The Open Journal
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
[![Build Status](https://github.com/nathanaelbosch/ProbNumDiffEq.jl/workflows/CI/badge.svg)](https://github.com/nathanaelbosch/ProbNumDiffEq.jl/actions)
[![Coverage](https://codecov.io/gh/nathanaelbosch/ProbNumDiffEq.jl/branch/main/graph/badge.svg?token=eufIemCGXn)](https://codecov.io/gh/nathanaelbosch/ProbNumDiffEq.jl)
[![Benchmarks](http://img.shields.io/badge/benchmarks-docs-blueviolet.svg)](https://nathanaelbosch.github.io/ProbNumDiffEq.jl/dev/benchmarks/multi-language-wrappers/)
[![DOI](https://joss.theoj.org/papers/10.21105/joss.07048/status.svg)](https://doi.org/10.21105/joss.07048)

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

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


## Citing ProbNumDiffEq.jl

If you use ProbNumDiffEq.jl helpful for your research project, please cite our JOSS paper ([link](https://doi.org/10.21105/joss.07048)):
```
@article{Bosch2024,
doi = {10.21105/joss.07048},
url = {https://doi.org/10.21105/joss.07048},
year = 2024,
publisher = {The Open Journal},
volume = 9,
number = 101,
pages = 7048,
author = {Nathanael Bosch},
title = {ProbNumDiffEq.jl: Probabilistic Numerical Solvers for Ordinary
Differential Equations in Julia},
journal = {Journal of Open Source Software}
}
```


## Related packages

- [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.
Expand Down

0 comments on commit c9174ed

Please sign in to comment.