The ULXLC Model v0.1
2016-11-22

predicting the long-term light curves of ULXs

The ULXLC model is a model which predicts the long-term light curves of Ultra Luminous X-ray sources (ULXs). It uses a simple geometrical picture, describing the accretion disc as a cone due to the large accreting rate. More information will be added soon and can be found in Dauser et al. (subm. to MNRAS).

Usage and Parameters

The parameters of the ULXLC model are briefly explained in the following. Importantly, the model can be both used to predict a complete light curve(dopulse=0), or only single pulses (dopulse=1). If you have question, please feel free to contact me.

norm: defined as intrinsic normalization, scales with the inferred boosting factor of the current geometry
period: period of the light curve (given in the time unit of your data; usually days)
phase: phase counted since the start of the light curve / pulse (can be >1)
theta: half opening angle (in degrees)
incl: inclination to the system (in degrees, 90 degrees is edge-on)
dincl: precession angle (i.e., the inclination varies between incl-dincl to incl+dincl; also in degrees)
beta: velocity of the outflow; given in units of the speed of light
dopulse: predict a complete light curve(dopulse=0), or only single pulses (dopulse=1)

The meaning of the parameters is the same as for the separate models (see relline description). Moreover, as the angular effects are properly treated, no "guess" regarding a limb brightening or darkening law is needed anymore.

Download

To install, please download the following file:

last changes in version
ulxlc_code_v0.1.tgz 2016-11-22 v0.1

To compile the model, put the downloaded tar file in a separate directory and unpack it:

tar xfz ulxlc_code_v0.1.tgz

In order to compile the model, it is recommended that you call the provided compile-script by executing:

  chmod u+x ./compile_ulxlc.csh
  ./compile_ulxlc.csh
In this way the model will be compiled to have the name ulxlc and you can simply load it in XSPEC with
  XSPEC12>lmod ulxlc .

IMPORTANT: If you want to use this model outside this directory you have to globally set the path to the table with the environment variable "ULXLC_TABLE_PATH" to the directory which contains the table. In a csh this can be done by the following command (assuming your model is installed in "/home/user/localmodels/ulxlc"):

  setenv ULXLC_TABLE_PATH "/home/user/localmodels/ulxlc"

The code here is still in BETA-test! Please contact me if you find bugs or encounter problems with the model.