Last modified: December 2023

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

xsgnei

Context: models

Synopsis

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

Syntax

xsgnei

The xsgnei 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".

Deprecated in Sherpa 4.10.0

The kt_ave parameter has been renamed meankt to match the XSPEC definition. The name kt_ave can still be used to access the parameter, but this name will be removed in a future release.


Example

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

Create a component of the xsgnei 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.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 abundance of the plasma, as defined by the set_xsabund function.
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.
norm The normalization of the model: see [1] for an explanation of the units.

References

XSPEC version

CIAO 4.16 comes with support for version 12.13.1e of the XSPEC models. This can be checked with the following:

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

Bugs

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

See Also

models
xsequil, xsnei, xsvgnei, xsvvgnei