Last modified: December 2025

URL: https://cxc.cfa.harvard.edu/sherpa/ahelp/xsbequil.html
AHELP for CIAO 4.18 Sherpa

xsbequil

Context: models

Synopsis

The XSPEC bequil model: collisional plasma, ionization equilibrium,

Syntax

xsbequil

The xsbequil model is an additive model component.

Description

The model is described at [1] . Use the set_xsxset function to change the "NEIVERS" setting.


Example

>>> create_model_component("xsbequil", "mdl")
>>> print(mdl)

Create a component of the xsbequil model and display its default parameters. The output is:

mdl
   Param        Type          Value          Min          Max      Units
   -----        ----          -----          ---          ---      -----
   mdl.kT       thawed            1       0.0808         79.9        keV
   mdl.Abundanc frozen            1            0        10000           
   mdl.Redshift frozen            0       -0.999           10           
   mdl.Velocity frozen            0            0        10000       km/s
   mdl.norm     thawed            1            0        1e+24           

PARAMETERS

The parameters for this function are:

Parameter Definition
kT The temperature in keV.
Abundanc The metal abundances (He fixed at that defined by the set_xsabund command). The elements included are C, N, O, Ne, Mg, Al, Si, S, Ar, Ca, Fe, and Ni. Relative abundances are set by set_xsabund ).
Redshift The redshift of the plasma.
Velocity The gaussian sigma for the velocity broadening (in km/s).
norm The normalization of the model.

References

[1]

Changes in CIAO

Added in CIAO 4.17

XSPEC version

CIAO 4.18 comes with support for version 12.14.0k of the XSPEC models. This can be checked with the following:

% python -c 'from sherpa.astro import xspec;
print(xspec.get_xsversion())'
12.14.0k

Bugs

See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.

See Also

models
xsbvequil