Skip to content

This repository hosts the diskSED spectral model, as described in Guolo & Mummery (2025).

Notifications You must be signed in to change notification settings

muryelgp/diskSED

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

README

Thank you for your interest in our work!

This repository hosts the diskSED model, as described in Guolo & Mummery (2025).

Requirements

Basic (Standard XSPEC Minimization)

  • Python 3
  • Astropy
  • NumPy
  • pyXSPEC (included as part of HEASoft)

Bayesian Analysis (Recommended)

  • All of the above
  • Bayesian X-ray Analysis (BXA)
  • UltraNest (or alternative Bayesian inference software)
  • Corner (for corner plots)

Installation

Standard Installation

pip install git+https://github.com/muryelgp/diskSED.git

Flexible Installation

git clone https://github.com/muryelgp/diskSED.git
cd diskSED
python3 -m pip install -e .

Tutorials

The Examples folder contains several Jupyter notebooks demonstrating step-by-step usage of the model:

  • prep_data.ipynb: Demonstrates how to prepare grouped X-ray spectra and UV/optical/NIR SED files.
  • fitting.ipynb: Shows how to load data, configure the model, and perform Bayesian fitting using pyXSPEC/BXA/UltraNest.
  • fancy_plots.ipynb: Provides instructions for generating plots of data, observed and intrinsic model SEDs, corner plots, and parameter histograms.
  • properties.ipynb: Explains how to estimate secondary parameters from the fit results (e.g., Black Hole Mass, outer radius in Rg, Bolometric Luminosity, and Eddington Ratio).
  • Planned Updates: Advanced techniques like multi-epoch joint fitting, non-standard priors, or non-standard likelihood functions (e.g., including upper limits), aditionon of non-thermal components, etc. See papers in Citations for examples.

Citations

If you use the diskSED model in any publication, please cite Guolo & Mummery (2025) along with its dependencies.

Examples of papers using diskSED

These papers provide examples of how to describe the model and properly cite dependencies. If these works have influenced or motivated your research, you are encouraged to cite them as well.

Recomended Reading

Statistics

Relevant Software Tutorial/Lectures

Time-dependent Disk Theory

Comments & Contact

  • If you're looking for the Relativistic version (kerrSED), it is unfortunately not publicly available yet.
  • The model is implemented only in Python and can therefore only be used with pyXSPEC. A C/Fortran version does not exist, and therefore the model is not compatible with standard XSPEC. Recommendation: Switch to pyXSPEC for greater flexibility, especially when dealing with high-dimensional models/data-sets and to use Bayesian inference methods.
  • If you're interested in implementing diskSED in standard XSPEC or have already done so, feel free to contact me so we can include it here.
  • Please note that we are not responsible for any misuse of the model, nor do we endorse results derived from it a priori. Users are encouraged to apply caution and sound scientific judgment. The model's assumptions and limitations are described in the original paper, particularly on sections 1 and 5, aditional questions can be send by email.
  • For general inquiries, contact me at [email protected]. Please check the tutorials first to see if your question has already been addressed.

About

This repository hosts the diskSED spectral model, as described in Guolo & Mummery (2025).

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages