Autocitations

Diffrax can autogenerate BibTeX citations for all the numerical methods you use.

Warning

This is an experimental feature that may change.

diffrax.citation(*args, **kwargs)

Autogenerate a list of BibTeX references for the numerical methods being used.

Arguments:

citation may be called with any subset of the argments to diffrax.diffeqsolve. To generate the citation list it may be easiest to simply replace diffeqsolve with citation.

Returns:

Nothing. Prints a BibTeX file to stdout.

Example

from diffrax import citation, Dopri5, PIDController

citation(solver=Dopri5(),
         stepsize_controller=PIDController(pcoeff=0.4, rtol=1e-3, atol=1e-6))

# % --- AUTOGENERATED REFERENCES PRODUCED USING `diffrax.citation(...)` ---
# % The following references were found for the numerical techniques being used.
# % This does not cover e.g. any modelling techniques being used.
#
# ...
# ... Full output truncated in this example!
# ... Here's what the final entry looks like:
# ...
#
# % The use of a PI-controller to adapt step sizes is from Section IV.2 of:
# @book{hairer2002solving-ii,
#   address={Berlin},
#   author={Hairer, E. and Wanner, G.},
#   edition={Second Revised Edition},
#   publisher={Springer},
#   title={{S}olving {O}rdinary {D}ifferential {E}quations {II} {S}tiff and
#          {D}ifferential-{A}lgebraic {P}roblems},
#   year={2002}
# }
# % and Sections 1--3 of:
# @article{soderlind2002automatic,
#     title={Automatic control and adaptive time-stepping},
#     author={Gustaf S{"o}derlind},
#     year={2002},
#     journal={Numerical Algorithms},
#     volume={31},
#     pages={281--310}
# }
#
# % --- END AUTOGENERATED REFERENCES ---