Skip to content

Commit 7f801fd

Browse files
authored
Merge pull request #641 from PyAutoLabs/docs/citations-exhaustive
docs: make software citations exhaustive vs current requirements
2 parents 60a2c48 + 91a1964 commit 7f801fd

5 files changed

Lines changed: 637 additions & 564 deletions

File tree

CITATIONS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ entry in the above .bib file is under the citation key `pyautolens`. Please also
1111
papers (<https://academic.oup.com/mnras/article/452/3/2940/1749640> and <https://academic.oup.com/mnras/article-abstract/478/4/4738/5001434?redirectedFrom=fulltext>) which are included
1212
under the citation keys `Nightingale2015` and `Nightingale2018`.
1313

14-
You should also specify the non-linear search(es) you use in your analysis (e.g. Dynesty, Emcee, PySwarms, etc) in
14+
You should also specify the non-linear search(es) you use in your analysis (e.g. Nautilus, Dynesty, Emcee, Zeus, etc) in
1515
the main body of text, and delete as appropriate any packages your analysis did not use. The citations.bib file includes
1616
the citation key for all of these projects.
1717

docs/general/citations.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,21 @@ entry in the above .bib file is under the citation key `pyautolens`. Please also
1313
papers (<https://academic.oup.com/mnras/article/452/3/2940/1749640> and <https://academic.oup.com/mnras/article-abstract/478/4/4738/5001434?redirectedFrom=fulltext>) which are included
1414
under the citation keys `Nightingale2015` and `Nightingale2018`.
1515

16-
You should also specify the non-linear search(es) you use in your analysis (e.g. Dynesty, Emcee, PySwarms, etc) in
16+
You should also specify the non-linear search(es) you use in your analysis (e.g. Nautilus, Dynesty, Emcee, Zeus, etc) in
1717
the main body of text, and delete as appropriate any packages your analysis did not use. The citations.bib file includes
1818
the citation key for all of these projects.
1919

20+
## JAX
21+
22+
**PyAutoLens** runs on a NumPy backend by default and an optional
23+
[JAX](https://github.com/jax-ml/jax) backend for just-in-time compilation, automatic
24+
differentiation, and GPU/TPU execution. If you run any analysis on the JAX path, please
25+
cite JAX under the citation key `jax`. JAX-specific components that are also cited under
26+
their own keys when used are `optax` (gradient-based optimizers, key `optax`), the
27+
interferometer non-uniform FFT (`nufftax` and its FINUFFT algorithm, keys `nufftax` and
28+
`finufft`, see below), and the critical-curve/caustic solver (`Jax-Zero-Contour`, key
29+
`jax_zero_contour`, see below).
30+
2031
## Jax-Zero-Contour
2132

2233
If you use the zero-contour method for critical curve and caustic computation (the default in

0 commit comments

Comments
 (0)