Skip to content

Commit 8b50019

Browse files
committed
readme: update citation information
1 parent 8460f8f commit 8b50019

File tree

3 files changed

+26
-14
lines changed

3 files changed

+26
-14
lines changed

CITATION.bib

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
@article{10.1093/mnras/staf1770,
2+
author = {Baker, F J E and Young, A J},
3+
title = {Gradus.jl: spacetime-agnostic general relativistic ray-tracing for X-ray spectral modelling},
4+
journal = {Monthly Notices of the Royal Astronomical Society},
5+
pages = {staf1770},
6+
year = {2025},
7+
month = {10},
8+
abstract = {We introduce Gradus.jl, an open-source and publicly available general relativistic ray-tracing toolkit for spectral modelling in arbitrary spacetimes. Our software is written in the Julia programming language, making use of forward-mode automatic differentiation for computing the Christoffel symbols during geodesic integration, and for propagating derivatives through the entire ray-tracer. Relevant numerical methods are detailed, and our models are validated using a number of tests and comparisons to other codes. The differentiability is used to optimally calculate Cunningham transfer functions – used to efficiently pre-compute relativistic effects in spectral models. A method is described for calculating such transfer functions for disc with non-zero vertical height, including the treatment of self-obscuration. An extension of the transfer function formalism that includes timing information is described, and used to calculate high-resolution reverberation lag spectra for a lamppost corona. The lag–frequency and lag–energy spectra for a Shakura–Sunyaev accretion disc with various lamppost heights and Eddington ratios are calculated, and the general impact of disc thickness in reflection models is discussed.},
9+
issn = {0035-8711},
10+
doi = {10.1093/mnras/staf1770},
11+
url = {https://doi.org/10.1093/mnras/staf1770},
12+
eprint = {https://academic.oup.com/mnras/advance-article-pdf/doi/10.1093/mnras/staf1770/64711491/staf1770.pdf},
13+
}

CITATION.cff

Lines changed: 0 additions & 12 deletions
This file was deleted.

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
# Gradus.jl
66

7+
<a href="https://ascl.net/2503.035">
8+
<img src="https://img.shields.io/badge/ascl-2503.035-blue.svg?colorB=262255" alt="ascl:2503.035" />
9+
</a>
710
<a href="https://codecov.io/gh/astro-group-bristol/Gradus.jl">
811
<img src="https://codecov.io/gh/astro-group-bristol/Gradus.jl/branch/main/graph/badge.svg?token=A91E22KZR5"/>
912
</a>
@@ -15,7 +18,7 @@
1518
</a>
1619
<a href="https://doi.org/10.5281/zenodo.6471796">
1720
<img src="https://zenodo.org/badge/DOI/10.5281/zenodo.6471796.svg" alt="DOI">
18-
</a>
21+
</a>
1922
<a href="https://astro-group-bristol.github.io/Gradus.jl/dev/">
2023
<img alt="Docs" src="https://img.shields.io/badge/docs-dev-blue.svg"/>
2124
</a>
@@ -71,12 +74,20 @@ julia> using Gradus
7174

7275
See [GettingStarted](https://astro-group-bristol.github.io/Gradus.jl/dev/getting-started/) for setting up your first traces.
7376

74-
## See also
77+
## See also
7578

7679
- [The Julia programming language](https://github.com/JuliaLang/Julia)
7780
- [DifferentialEquations.jl](https://github.com/SciML/DifferentialEquations.jl)
7881
- [ForwardDiff.jl](https://github.com/JuliaDiff/ForwardDiff.jl)
7982

83+
## Citing
84+
85+
If you use Gradus.jl in your work, please cite [Baker & Young (2025)](./CITATION.bib).
86+
87+
There are various other ways to reference Gradus.jl:
88+
- [ascl:2503.035](https://ascl.net/2503.035)
89+
- [10.5281/zenodo.6471796](https://zenodo.org/records/6471796)
90+
8091
<hr>
8192

8293
<p align="center"> Astrophysics Group Bristol </p>

0 commit comments

Comments
 (0)