Logo HCm

HII-CHI-mistry

Back to main page

DESCRIPTION

HII-CHI-mistry is a python program that calculates, for gaseous nebulae ionized by massive stars or active galactic nuclei, the oxygen abundance in terms of 12+log(O/H), the nitrogen-to-oxygen ratio as log(N/O) and the ionisation parameter as log U from a set of emission-line optical intensities, consistently with the direct method. The methodology and the results are described in Pérez-Montero (2014, MNRAS, 441, 2663).

HISTORY AND DOWNLOADS

Each compressed tar.gz file contains the python file of the code, the libraries of the models and a file with instructions

- Version 5.0 (2020/11).
From this version, it is not anymore required to give all lines in the input, but a label indicates what lines are given, including an identification one for each row.
- Version 4.2 (2020/05).
From this version interpolated grid of models are calculated by the code, reducing the number of required library files.
- Version 4.1 (2019/08).
Now compatible with python 3 and better management of the errors has been included
- Version 4.0 (2019/03).
This version allows to calculate abundances for the NLR in AGNs using a double composite power law spectral energy distribution. The results and methods are discussed for this part in Pérez-montero et al (2019). Additionally the code now also uses [NeIII] 3868 Angströms emission line to derive oxygen abundances. Finally the output file now includes a header with useful information.
- Version 3.1 (2018/12).

Models have been now calculated using Cloudy v.17.00.

- Version 3.0 (2017/09). The errors of the input intensity lines are now considered in the calculation of the errors of the derived abundances and log U. To do so an iterative Monte-Carlo simulation is performed in the script. In addition, in the interpolated grid of models, this grid is only used once a first estimation of the results is obtained to reduce the time of calculation.

- Version 2.2 (2017/02)

(In order to avoid some divergences in the calculation of O/H, it enhances in the interpolated mode the parameter defined to fix the number of constrained models once calculated N/O).<

-Version 2.0 (2016/01)

(This version uses the library numpy, so asciidata is not anymore required. the results are now stored in an independent ascii file. Finally this version lets the user to choose a model grid of better resolution in O/H and N/O to smooth results around the knots of the model grid. In addition, the program uses all the models for the weighted means of the results, not just a subset of them as in previous versions.)

- Version 1.2 (2015/08) (It fixes a bug for observational sets with [OIII[ 4363 but without [NII] 6584 for N/O and it expands the metallicity range from 12+log(O/H) = 6.9).

- Version 1.0 (2014/04)

HOW TO RUN IT

HII-CHI-mistry has been written in python v. 2.7, but from version 4.1 it is also compatible with python 3. It requires the library numpy (versions previous to v2.0 use the library asciidata). It also needs the files of the relative emission line intensities predicted by the models, assuming a different set of input conditions, including:

C17_popstar.dat
C17-popstar_logU_adapted_emp.dat
C17_popstar_logU-NO_adapted_emp.dat

These files represent the whole set of models, limiting the values of log U at each Z (left picture), and limiting also the values of N/O, respectively (right picture).
All were calculated with Cloudy v.17 and a POPSTAR SED at an age of 1Myr with an IMF of Chabrier.

For calculations for the NLR in AGNs it is also included those files from models calculated using a double composite power-law with parameter alpha(UV) = -1.0 and alpha(OX) = -0.8. Additional versions of the code are calculated using an alpha(ox) = -1.2.
C17_agn_v5.0.dat
C17_agn_NO_adapted_emp_v5.0.dat
Notice that in the case of AGN no constrained version for log U is supplied.

To run the program, just type (for v5.0, in other versions use the name of thecorresponding python script ):

> python HCm_v5.0.py

Once the input file has been specified in the prompt or by direct question, the code will ask about what SED of models is going to be used: (1) Young POPSTAR massive cluster, (2) BPASS cluster models atmospheres with binaries, (3) double composite power-law AGN with alpha = -0.8 or (4) alpha = -1.2. Then, the program will ask about the use of a interpolated high-resolution grid : (0) non-interpolated or (1) interpolated. This will enhance the resolution of the grid in O/H, N/O, and log U in a factor 10, but it will decrease the speed of calculation.

THE INPUT FILE

It must be written in text format with a first row with the labels for the different columns, corresponding to the identification of each row and those containing the emission line fluxes and their errors relative to Hbeta. the following labels can be read by the code:

["ID" ! for the identification name of the row
"OII_3727" and "eOII_3727" for [OII] 3727/Hbeta with its error
"NeIII_3868" and "eNeIII_3868" for [NeIII] 3868/Hbeta with its error
"OIII_4363" and "eOIII_4363" for [OIII] 4363/Hbeta with its error
"OIII_4959" and "eOIII_4959" for [OIII] 4959/Hbeta with its error
"OIII_5007" and "eOIII_5007" for [OIII] 5007/Hbeta with its error. It is possible to give only one of the two strong [OIII] nebular lines.
"NII_6584" and "eNII_6584" for [NII] 6584/Hbeta with its error
"SII_6725" and "eSII_6725" for [SII] 6717+6731/Hbeta with its error
all of them reddening corrected. If no information exists about a certain line it must typed as zero.

RESULTS

If the input file is correctly introduced, the program will ask for the chosen SED and the use of interpolations and it will calculate the wanted quantities and their corresponding errors.
The information will be displayed in the screen for each object, along with the ratio of completeness of the task. It will be also added an index saying
what grid was used, where

1: the complete grid is used (only if [OIII] 4363 > 0)
2: the log U limited grid is used (when [OIII] 4363 = 0)
3: the log U and N/O limited grid is used
(if, besides, [NII]/[OII] and [NII]/[SII] cannot be obtained).

In addition, it will create a file called using the name of the input file + "_hcm-output.dat" with the information about the used models, the identification of each row, the columns of the input emission lines and seven new columns will be added to the input file with the
following information:

grid index
12+log(O/H)
error of 12+log(O/H)
log(N/O) (-10 if grid 3 is used)
error of log(N/O)
log U
error of log(U) (take with care if grid 2 or 3 are used)

Enrique Pérez-Montero. IAA-CSIC
Last update: 2020, November

This program has been made thanks to the financial support from the Spanish AYA project Estallidos