Last modified: December 2024

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

xsbvequil

Context: models

Synopsis

The XSPEC bvequil model: collisional plasma, ionization equilibrium,

Syntax

xsbvequil

The xsbvequil 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("xsbvequil", "mdl")
>>> print(mdl)

Create a component of the xsbvequil 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.He       frozen            1            0        10000           
   mdl.C        frozen            1            0        10000           
   mdl.N        frozen            1            0        10000           
   mdl.O        frozen            1            0        10000           
   mdl.Ne       frozen            1            0        10000           
   mdl.Mg       frozen            1            0        10000           
   mdl.Si       frozen            1            0        10000           
   mdl.S        frozen            1            0        10000           
   mdl.Ar       frozen            1            0        10000           
   mdl.Ca       frozen            1            0        10000           
   mdl.Fe       frozen            1            0        10000           
   mdl.Ni       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.
He The abundance relative to Solar.
C The abundance relative to Solar.
N The abundance relative to Solar.
O The abundance relative to Solar.
Ne The abundance relative to Solar.
Na The abundance relative to Solar.
Mg The abundance relative to Solar.
Al The abundance relative to Solar.
Si The abundance relative to Solar.
S The abundance relative to Solar.
Ar The abundance relative to Solar.
Ca The abundance relative to Solar.
Fe The abundance relative to Solar.
Ni The abundance relative to Solar.
Redshift The redshift of the plasma.
Velocity The gaussian sigma for the velocity broadening (in km/s).
norm The normalization of the model.

References

Changes in CIAO

Added in CIAO 4.17

XSPEC version

CIAO 4.17 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
xsbequil