IONeq: An X-ray absorption model including ionization equilibrium conditions.

IONeq is an X-ray high-resolution photoabsorption model which computes the optical depth τ(E) simultaneously for ions of all abundant elements, assuming ionization equilibrium and taking into account turbulent broadening. This model has been developed by Efrain Gatuzz and Eugene Churazov. A complete description of the science behind the model is described in Gatuzz & Churazov (2017).

Required Files

File Description Size Version
ioneq.v1.0.tar.gz Complete Model 73.7 Mb 1.0

The contents of the tarfile include:

atomic_data/AtomicData.fits -- atomic database binary .fits file. This must reside in the directory atomic_data inside the folder where the model is located.

ioneq.f90 -- source code for IONeq -- global variables definition.

tab-auger-Wijk.dat -- Auger probabilities

lmodel.dat -- local model definition file needed by xspec. -- installation script written on bash for LINUX. -- installation script written on bash for MAC.



The models require the FFTW library (libfftw3). FFTW is available with most well-known GNU/Linux distributions and is also available on OS X using macports or fink. For some distributions the library and the development packages are separate, in which case both must be installed. FFTW can be download from here

The FFTW library must be linked to the Xspec local models library. This can be done by rebuilding the XSPEC binary (see the "Third-Party Libraries In Local Models Build" section in the XSPEC manual).

After linking the library you can use the compile_linux(mac).sh file to install the model by doing
sh compile_linux(mac).sh
Or you can setting up and using this model as described in the xspec manual:

0) You need to have the heasoft package installed on your machine, but it must be built from source. Local models cannot be installed from a binary installation.

1) Untar the tarfile somewhere in your user area.

2) Setup your headas environment (eg. 'setenv HEADAS /path/to/architecture', and 'source \$HEADAS/headas-init.csh').
'initpackage ioneq lmodel.dat path-to-model-directory',
where path-to-model-directory is the full path of the model directory.

After the build is complete type
'lmod ioneq path-to-current-directory'
In subsequent sessions you don't need to do the initpackage step again, just the lmod.


The input parameters include the hydrogen column density (in units of 1022 cm-2), the temperature (log T), the ionization parameter (log ξ), the O, Fe and Ne atomic abundances (relative to Grevesse & Sauval, 1998), the Fe metallic iron abundance and the turbulence broadening (in units of km/s). The redshift is also a model parameter.

Note that the IONeq does not solve the thermal equilibrium equations, that is the balance heating rate=cooling rate, from which one obtain the gas temperature. Instead, we treat both, the gas temperature T and the ionization parameter ξ, as independent (free) parameters of the model.

Atomic Data

With the default set up - that is, if you have run compile_linux(mac).sh, the model will look for the cross-section data file in atomic_data/AtomicData.fits, relative to the directory in which the module is located.

The XSPEC xset command can be used to set the IONEQROOT variable; if this is set then it is used instead of the path to the module. So after
xset IONEQROOT /data/ioneq/
then the model will use the file /data/ioneq/atomic_data/AtomicData.fits (the IONEQROOT refers to the directory containing the atomic_data/ directory). Note that IONEQROOT over-rides any changes made by running compile_linux(mac).sh when building the model.

The location of the file can be found by setting the XSPEC chatter level to 20 or higher - e.g.

chatter 20

before evaluating the model.

We include in our model the following atomic data, in order to compute the ion fractions assuming ionization equilibrium:
  • Collisional ionization: ionization rates from Voronov (1997).
  • Radiative recombination: rates from Verner & Ferland (1996).
  • Dielectronic recombination: rates from Arnaud & Rothenflug (1985).
  • Photoionization: cross sections from Verner et al. (1996) and Auger probabilities from Kaastra & Mewe (1993).

NOTE: In order to compute the optical depth, IONeq uses the same high-resolution photoabsorption cross-sections included in the XSTAR photonionization code.

Figure below shows the best-fit obtained with the IONeq model for Cygnus X-2 and PKS2155-304 high-resolution Chandra spectra. Absorption lines identified in the Ne and O absorption edge regions are indicated (for more details see Gatuzz & Churazov 2017).


This model was used to analyze the neutral-warm-hot ISM phases using high-resolution X-ray spectra. The figure below shows the column densities obtained for the different phases using galactic (blue points) and extragalactic (red points) sources (for more details see Gatuzz & Churazov 2017).


Additional models

As is indicated in Gatuzz & Churazov 2017, we provide two versions of the IONeq model. For one version the value of the thermal velocity (Vth) was pre-computed for each ion by setting the temperature "T" in Equation (5) to the temperature at which the ion fraction is maximal in CIE. That is the version provided in the link above.

The second version of the IONeq model performs the proper optical depth convolution for each ion using the temperature parameter and can be downloaded from here


The IONeq will be continuously expanded and improved. For comments or questions about its implementation please contact Efrain Gatuzz or Eugene Churazov.

Xspec Xspec Home Page

HEASARC Home | Observatories | Archive | Calibration | Software | Tools | Students/Teachers/Public

Last modified: Thursday, 09-Nov-2017 16:25:28 EST

HEASARC support for unencrypted FTP access ended on September 20, 2019. Please see this notice for details.