Skip to content

This is the repository for reltrans, the X-ray reverberation black hole model family.

License

Notifications You must be signed in to change notification settings

fjebaker/reltrans

 
 

Repository files navigation

Docs License GitHub release

Reltrans

Reltrans is an X-ray reverberation mapping model designed to be applicable to both AGN and black hole X-ray binaries. It can be used to model both time averaged spectra, and energy-dependent cross spectra. Depending on the model version, the model can be used to characterize accretion flows and to estimate black hole mass, spin, and source distance.

Documentation

You can find the documentation at this link. The documentation provides detailed installation and setup in instructions, and describes the various flavours of the model that are available to the users.

Reporting errors and requesting features

We welcome comments and contributions from the community. The best way to get in touch is via the issues_ page, which you can use both to report bugs or odd model behaviour, and to request or discuss features.

Citing Reltrans

If you use Reltrans in your research, we ask that you please cite the following papers:

  • Ingram et al., 2019 MNRAS, 488, 324 [DOI] [ADS] [Copy BibTeX to clipboard]
  • Mastroserio et al., 2021 MNRAS, 507, 55M [DOI] [ADS] [Copy BibTeX to clipboard]

Additionally, if you use the RTDist flavour we ask that you also cite:

  • Ingram et al., 2022 MNRAS, 509, 619 [DOI] [ADS] [Copy BibTeX to clipboard]

Finally, if you use the double lamp post flavour, we ask that you also cite:

  • Lucchini et al., 2023 ApJ, 951, 19 [DOI] [ADS] [Copy BibTeX to clipboard]

About

This is the repository for reltrans, the X-ray reverberation black hole model family.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Fortran 95.8%
  • Python 2.4%
  • C 1.1%
  • Other 0.7%