Skip to content

Commit a1a4077

Browse files
authored
docs: update readme with new JOSS citation (#1564)
* update readme with new joss citation * small fixes * fixes from feedback * fix links
1 parent b6af2e0 commit a1a4077

File tree

2 files changed

+184
-38
lines changed

2 files changed

+184
-38
lines changed

CITATION.cff

Lines changed: 149 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,161 @@
1-
cff-version: 1.2.0
2-
message: "Please cite https://doi.org/10.21105/joss.02505 also"
3-
title: "sbi: Simulation-based inference toolkit"
1+
cff-version: "1.2.0"
42
authors:
5-
- family-names: Tejero-Cantero
6-
given-names: Alvaro
7-
orcid: "http://orcid.org/0000-0002-8768-4227"
83
- family-names: Boelts
94
given-names: Jan
10-
orcid: "http://orcid.org/0000-0003-4979-7092"
115
- family-names: Deistler
126
given-names: Michael
13-
orcid: "http://orcid.org/0000-0002-3573-0404"
7+
- family-names: Gloeckler
8+
given-names: Manuel
9+
- family-names: Tejero-Cantero
10+
given-names: Álvaro
1411
- family-names: Lueckmann
1512
given-names: Jan-Matthis
16-
orcid: "http://orcid.org/0000-0003-4320-4663"
13+
- family-names: Moss
14+
given-names: Guy
15+
- family-names: Steinbach
16+
given-names: Peter
17+
- family-names: Moreau
18+
given-names: Thomas
19+
- family-names: Muratore
20+
given-names: Fabio
21+
- family-names: Linhart
22+
given-names: Julia
1723
- family-names: Durkan
1824
given-names: Conor
19-
orcid: "http://orcid.org/0000-0001-9333-7777"
20-
- family-names: Gonçalves
25+
- family-names: Vetter
26+
given-names: Julius
27+
- family-names: Miller
28+
given-names: Benjamin Kurt
29+
- family-names: Herold
30+
given-names: Maternus
31+
- family-names: Ziaeemehr
32+
given-names: Abolfazl
33+
- family-names: Pals
34+
given-names: Matthijs
35+
- family-names: Gruner
36+
given-names: Theo
37+
- family-names: Bischoff
38+
given-names: Sebastian
39+
- family-names: Krouglova
40+
given-names: Nastya
41+
- family-names: Gao
42+
given-names: Richard
43+
- family-names: Lappalainen
44+
given-names: Janne K
45+
- family-names: Mucsányi
46+
given-names: Bálint
47+
- family-names: Pei
48+
given-names: Felix
49+
- family-names: Schulz
50+
given-names: Auguste
51+
- family-names: Stefanidi
52+
given-names: Zinovia
53+
- family-names: Rodrigues
2154
given-names: Pedro
22-
orcid: "http://orcid.org/0000-0002-6987-4836"
55+
- family-names: Schröder
56+
given-names: Cornelius
57+
- family-names: Zaid
58+
given-names: Faried Abu
59+
- family-names: Beck
60+
given-names: Jonas
61+
- family-names: Kapoor
62+
given-names: Jaivardhan
2363
- family-names: Greenberg
24-
given-names: David
25-
orcid: "http://orcid.org/0000-0002-8515-0459"
64+
given-names: David S.
65+
- family-names: Gonçalves
66+
given-names: Pedro J.
67+
- family-names: Macke
68+
given-names: Jakob H.
69+
contact:
70+
- family-names: Boelts
71+
given-names: Jan
72+
- family-names: Deistler
73+
given-names: Michael
2674
- family-names: Macke
27-
given-names: Jakob
28-
orcid: "https://orcid.org/0000-0001-5154-8912"
29-
30-
version: 0.21.0
31-
date-released: "2022-12-22"
32-
identifiers:
33-
- type: "ascl-id"
34-
value: "2306.002"
35-
- type: "doi"
36-
value: 10.21105/joss.02505
37-
- type: "bibcode"
38-
value: "2023ascl.soft06002T"
39-
abstract: "Simulation-based inference is the process of finding parameters of a simulator from observations. The PyTorch package sbi performs simulation-based inference by taking a Bayesian approach to return a full posterior distribution over the parameters, conditional on the observations. This posterior can be amortized (<i>i.e.</i> useful for any observation) or focused (<i>i.e.</i>tailored to a particular observation), with different computational trade-offs. The code offers a simple interface for one-line posterior inference."
40-
license: AGPL-3.0
41-
repository-code: https://github.com/mackelab/sbi
75+
given-names: Jakob H.
76+
doi: 10.5281/zenodo.15034786
77+
message: If you use this software, please cite our article in the
78+
Journal of Open Source Software.
79+
preferred-citation:
80+
authors:
81+
- family-names: Boelts
82+
given-names: Jan
83+
- family-names: Deistler
84+
given-names: Michael
85+
- family-names: Gloeckler
86+
given-names: Manuel
87+
- family-names: Tejero-Cantero
88+
given-names: Álvaro
89+
- family-names: Lueckmann
90+
given-names: Jan-Matthis
91+
- family-names: Moss
92+
given-names: Guy
93+
- family-names: Steinbach
94+
given-names: Peter
95+
- family-names: Moreau
96+
given-names: Thomas
97+
- family-names: Muratore
98+
given-names: Fabio
99+
- family-names: Linhart
100+
given-names: Julia
101+
- family-names: Durkan
102+
given-names: Conor
103+
- family-names: Vetter
104+
given-names: Julius
105+
- family-names: Miller
106+
given-names: Benjamin Kurt
107+
- family-names: Herold
108+
given-names: Maternus
109+
- family-names: Ziaeemehr
110+
given-names: Abolfazl
111+
- family-names: Pals
112+
given-names: Matthijs
113+
- family-names: Gruner
114+
given-names: Theo
115+
- family-names: Bischoff
116+
given-names: Sebastian
117+
- family-names: Krouglova
118+
given-names: Nastya
119+
- family-names: Gao
120+
given-names: Richard
121+
- family-names: Lappalainen
122+
given-names: Janne K
123+
- family-names: Mucsányi
124+
given-names: Bálint
125+
- family-names: Pei
126+
given-names: Felix
127+
- family-names: Schulz
128+
given-names: Auguste
129+
- family-names: Stefanidi
130+
given-names: Zinovia
131+
- family-names: Rodrigues
132+
given-names: Pedro
133+
- family-names: Schröder
134+
given-names: Cornelius
135+
- family-names: Zaid
136+
given-names: Faried Abu
137+
- family-names: Beck
138+
given-names: Jonas
139+
- family-names: Kapoor
140+
given-names: Jaivardhan
141+
- family-names: Greenberg
142+
given-names: David S.
143+
- family-names: Gonçalves
144+
given-names: Pedro J.
145+
- family-names: Macke
146+
given-names: Jakob H.
147+
date-published: 2025-04-08
148+
doi: 10.21105/joss.07754
149+
issn: 2475-9066
150+
issue: 108
151+
journal: Journal of Open Source Software
152+
publisher:
153+
name: Open Journals
154+
start: 7754
155+
title: "sbi reloaded: a toolkit for simulation-based inference
156+
workflows"
157+
type: article
158+
url: "https://joss.theoj.org/papers/10.21105/joss.07754"
159+
volume: 10
160+
title: "sbi reloaded: a toolkit for simulation-based inference
161+
workflows"

README.md

Lines changed: 35 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![Tests](https://github.com/sbi-dev/sbi/actions/workflows/ci.yml/badge.svg)](https://github.com/sbi-dev/sbi/actions)
55
[![codecov](https://codecov.io/gh/sbi-dev/sbi/branch/main/graph/badge.svg)](https://codecov.io/gh/sbi-dev/sbi)
66
[![GitHub license](https://img.shields.io/github/license/sbi-dev/sbi)](https://github.com/sbi-dev/sbi/blob/master/LICENSE.txt)
7-
[![DOI](https://joss.theoj.org/papers/10.21105/joss.02505/status.svg)](https://doi.org/10.21105/joss.02505)
7+
[![DOI](https://joss.theoj.org/papers/10.21105/joss.07754/status.svg)](https://doi.org/10.21105/joss.07754)
88
[![NumFOCUS affiliated](https://camo.githubusercontent.com/a0f197cee66ccd8ed498cf64e9f3f384c78a072fe1e65bada8d3015356ac7599/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4e756d464f4355532d616666696c696174656425323070726f6a6563742d6f72616e67652e7376673f7374796c653d666c617426636f6c6f72413d45313532334426636f6c6f72423d303037443841)](https://numfocus.org/sponsored-projects/affiliated-projects)
99

1010
## `sbi`: Simulation-Based Inference
@@ -116,7 +116,7 @@ To install `sbi` run
116116
uv add sbi
117117
```
118118

119-
### Test the installation
119+
### Testing the installation
120120

121121
Open a Python prompt and run
122122

@@ -243,9 +243,33 @@ Institute for Europe, and by NumFOCUS.
243243

244244
## Citation
245245

246-
If you use `sbi` consider citing the [sbi software
247-
paper](https://doi.org/10.21105/joss.02505), in addition to the original research
248-
articles describing the specific sbi-algorithm(s) you are using.
246+
The `sbi` package has grown and improved significantly since its initial release, with
247+
contributions from a large and diverse community. To reflect these developments and the
248+
expanded functionality, we published an [updated JOSS
249+
paper](https://doi.org/10.21105/joss.07754). We encourage you to cite this
250+
newer version as the primary reference:
251+
252+
```latex
253+
@article{BoeltsDeistler_sbi_2025,
254+
doi = {10.21105/joss.07754},
255+
url = {https://doi.org/10.21105/joss.07754},
256+
year = {2025},
257+
publisher = {The Open Journal},
258+
volume = {10},
259+
number = {108},
260+
pages = {7754},
261+
author = {Jan Boelts and Michael Deistler and Manuel Gloeckler and Álvaro Tejero-Cantero and Jan-Matthis Lueckmann and Guy Moss and Peter Steinbach and Thomas Moreau and Fabio Muratore and Julia Linhart and Conor Durkan and Julius Vetter and Benjamin Kurt Miller and Maternus Herold and Abolfazl Ziaeemehr and Matthijs Pals and Theo Gruner and Sebastian Bischoff and Nastya Krouglova and Richard Gao and Janne K. Lappalainen and Bálint Mucsányi and Felix Pei and Auguste Schulz and Zinovia Stefanidi and Pedro Rodrigues and Cornelius Schröder and Faried Abu Zaid and Jonas Beck and Jaivardhan Kapoor and David S. Greenberg and Pedro J. Gonçalves and Jakob H. Macke},
262+
title = {sbi reloaded: a toolkit for simulation-based inference workflows},
263+
journal = {Journal of Open Source Software}
264+
}
265+
```
266+
267+
This updated paper, with its expanded author list, reflects the broader community
268+
contributions and the package's enhanced capabilities in releases
269+
[0.23.0](https://github.com/sbi-dev/sbi/releases/tag/v0.23.3) and later.
270+
271+
If you are using a version of `sbi` prior to 0.23.0, please cite the original sbi
272+
software paper:
249273

250274
```latex
251275
@article{tejero-cantero2020sbi,
@@ -262,7 +286,9 @@ articles describing the specific sbi-algorithm(s) you are using.
262286
}
263287
```
264288

265-
The above citation refers to the original version of the `sbi` project and has a
266-
persistent DOI. Additionally, new releases of `sbi` are citable via
267-
[Zenodo](https://zenodo.org/record/3993098), where we create a new DOI for every
268-
release.
289+
Regardless of which software paper you cite, please also remember to cite the original
290+
research articles describing the specific sbi-algorithm(s) you are using.
291+
292+
Specific releases of `sbi` are also citable via
293+
[Zenodo](https://zenodo.org/records/15034786), where we generate a new software DOI for
294+
each release.

0 commit comments

Comments
 (0)