Last modified: December 2025

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

xsbgnei

Context: models

Synopsis

The XSPEC bgnei model: collisional plasma, non-equilibrium, temperature evolution.

Syntax

xsbgnei

The xsbgnei model is an additive model component.

Description

The model is described at [1] . The set_xsxset and get_xsxset functions are used to set and query the XSPEC XSET parameters, in particular the keyword "NEIVERS".


Example

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

Create a component of the xsbgnei 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.Tau      thawed        1e+11        1e+08        5e+13     s/cm^3
   mdl.meankT   thawed            1       0.0808         79.9        keV
   mdl.Redshift frozen            0       -0.999           10           
   mdl.Velocity frozen            0            0        10000       km/s
   mdl.norm     thawed            1            0        1e+24           

ATTRIBUTES

The attributes for this object are:

Attribute Definition
kT The temperature of the plasma, 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 ).
Tau The ionization timescale in units of s/cm^3.
meankT The ionization timescale averaged plasma temperature in keV.
Redshift The redshift of the plasma.
Velocity The gaussian sigma for the velocity broadening (in km/s).
norm The normalization of the model: see [1] for an explanation of the units.

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
xsbvgnei, xsbvvgnei