v0.1.1

What's changed

• Added KLINE_PROF_DATA_DIR environment variable to point to the data directory containing the table model FITS file (#5)
• Fixed NaN bug (#6)

Known bugs

• Emissivities of zero in kline5 and kconv5 throw errors (#1)

Usage

To use the model, download from the release binaries below a .zip file corresponding to the arch/OS that you are running XSPEC in. Note this does not always align with your machine directly, for example, running XSPEC in a Docker container on an M1 Mac needs aarch64-linux-gnu, not aarch64-macos-none.

• A pre-computed transfer function table is also needed. At time of writing, the release with the latest table model is v0.1.0, which is a table for the Kerr metric with $a \in [-0.998, 0.998]$ and $\theta_\text{obs} \in [ 0^{\circ}, 90^{\circ} ]$.

Unzip the directory and data. If the data is not in the XSPEC fitting CWD, use the environment variable KLINE_PROF_DATA_DIR to point to the directory containing the table model.

Within XSPEC, navigate to the unzipped binary directory to build and load the model:

    XSPEC> hmake
    XSPEC> lmod klineprofiles .
    XSPEC> model kline

Models and model parameters are documented in the README.

Full Changelog: v0.1.0...v0.1.1

v0.1.0

• Added convolution models
• Fixed various XSPEC related bugs

Note: The convolution models are largely untested and should not be considered in any way complete or reliable at this stage.

Usage

To use the model, download from the release binaries below a .zip file corresponding to the arch/OS that you are running XSPEC in. Note this does not always align with your machine directly, for example, running XSPEC in a Docker container on an M1 Mac needs aarch64-linux-gnu, not aarch64-macos-none.

• A pre-computed transfer function table is also needed. In the releases below is such a table for the Kerr metric, with $a \in [-0.998, 0.998]$ and $\theta_\text{obs} \in [ 0^{\circ}, 90^{\circ} ]$.

Unzip the directory and move the corresponding transfer function table into the same directory (this is also downloaded from the release page).

Within XSPEC, build and load the model:

    XSPEC> hmake
    XSPEC> lmod klineprofiles .
    XSPEC> model kline

Models and model parameters are documented in the README.

Troubleshooting

• There is an anticipated issue relating to the absolute path in XSPEC, which should be fixed in this release. If it is not, please open an issue to report what went wrong.

Known bugs

• Emissivities of zero in the kline5 and kconv5 throw errors (#1)

Full Changelog: v0.0.2-alpha...v0.1.0

v0.0.2-alpha

This pre-release is intended for testing the distribution. The model should not be considered in any way complete or reliable at this stage.

• Fixed interpolation errors.
• Fixed error related to not reading full transfer function table.
• Checked against analytic and other models. Model is now perfectly functional, though in need of much optimization.
• Updated transfer functions table.

Usage: To use the model, download from the release tab the .zip file corresponding to the arch/OS that you are running XSPEC in. Note this does not always align with your machine directly, for example, running XSPEC in a Docker container on an M1 Mac needs aarch64-linux-gnu.

Unzip the directory and move the corresponding transfer function table into the same directory (this is also downloaded from the release page).

Within XSPEC, build and load the model:

    XSPEC> hmake
    XSPEC> lmod klineprofile .
    XSPEC> model klineprofile

Available parameters in this release are

• a: black hole spin in dimensionless units.
• incl: the inclination angle in degrees.
• Eline: energy corresponding to the delta function which is relativistically blurred by this model (e.g. Fe-Kalpha).
• rmin: inner radius of the disc
• rout: outer radius of the disc

Full Changelog: https://github.com/fjebaker/lineprofiles/commits/v0.0.1-alpha2

v0.0.1-alpha

This pre-release is intended for testing the distribution. The model should not be considered in any way complete or reliable at this stage.

Usage: To use the model, download from the release tab the .zip file corresponding to the arch/OS that you are running XSPEC in. Note this does not always align with your machine directly, for example, running XSPEC in a Docker container on an M1 Mac needs aarch64-linux-gnu.

Unzip the directory and move the corresponding transfer function table into the same directory (this is also downloaded from the release page).

Within XSPEC, build and load the model:

    XSPEC> hmake
    XSPEC> lmod klineprofile .
    XSPEC> model klineprofile

Available parameters in this release are

• a: black hole spin in dimensionless units.
• incl: the inclination angle in degrees.
• Eline: energy corresponding to the delta function which is
  relativistically blurred by this model (e.g. Fe-Kalpha).

Full Changelog: https://github.com/fjebaker/lineprofiles/commits/v0.0.1-alpha