AtomNeb (Python)

AtomNeb - Python Package for Atomic Data of Ionized Nebulae

PyPI Version Build Status Build Status Coverage Status GitHub license Anaconda Cloud Documentation Status Support Python versions 2.7 and 3.8 Zenodo JOSS https://mybinder.org/badge_logo.svg

Description

AtomNeb-py is a library written in Python for reading atomic data from AtomNeb, which is a database containing atomic data stored in the Flexible Image Transport System (FITS) file format for collisionally excited lines and recombination lines typically observed in spectra of ionized gaseous nebulae. The AtomNeb database were generated for use in pyEQUIB, proEQUIB, and other nebular spectral analysis tools.

Collisionally Excited Lines

AtomNeb for collisionally excited lines contains sets of atomic datasets, which include energy levels (Ej), collision strengths (Ωij), and transition probabilities (Aij) of the most ions commonly observed in ionized nebulae.

The atomic datasets for collisionally excited lines are as follows:

Each dataset contains the following atomic data FITS files: AtomElj.fits for Energy Levels (Ej), AtomOmij.fits for Collision Strengths (Ωij), and AtomAij.fits for Transition Probabilities (Aij).

Recombination Lines

AtomNeb for recombination lines contains sets of effective recombination coefficients (αeff) of recombination lines of H I, He I, He II, C I, C II, C III, C VI, N II, N III, N IV, N V, N VI, N VII, O II, O III, O IV, O V, O VI, O VIII, and Ne II ions typically observed in ionized nebulae, as well as Branching ratios (Br) of O II and N II lines.

The atomic datasets for recombination lines are as follows:

Installation

Dependent Python Packages

This package requires the following packages:

The previous version relied on pandas, but all the data structures were changed from pandas.DataFrame to those defined by NumPy that speed up the computations and reduce the memory usage.

  • To get this package with all the FITS file, you can simply use git command as follows:
git clone https://github.com/atomneb/AtomNeb-py

cd AtomNeb-py/atomic-data-rc/
tar -xvf *.fits.tar.gz

To install the last version, all you should need to do is

$ python setup.py install

To install the stable version, you can use the preferred installer program (pip):

$ pip install atomneb

or you can install it from the cross-platform package manager conda:

$ conda install -c conda-forge atomneb

How to Use

The Documentation of the functions provides in detail in the API Documentation (atomneb.github.io/AtomNeb-py/doc). There are two main categories: collisionally excited lines (CEL) and recombination lines (RC).

See Jupyter Notebooks: Notebooks.ipynb

Run Jupyter Notebooks on Binder:

https://mybinder.org/badge_logo.svg

Documentation

For more information on how to use the API functions from the AtomNeb Python package, please read the API Documentation published on atomneb.github.io/AtomNeb-py.

References

Citation

Using the AtomNeb Python package in a scholarly publication? Please cite these papers:

@article{Danehkar2020,
  author = {{Danehkar}, Ashkbiz},
  title = {AtomNeb Python Package, an addendum to AtomNeb: IDL Library
           for Atomic Data of Ionized Nebulae},
  journal = {Journal of Open Source Software},
  volume = {5},
  number = {55},
  pages = {2797},
  year = {2020},
  doi = {10.21105/joss.02797}
}

and if you use the AtomNeb IDL library:

@article{Danehkar2019,
  author = {{Danehkar}, Ashkbiz},
  title = {AtomNeb: IDL Library for Atomic Data of Ionized Nebulae},
  journal = {Journal of Open Source Software},
  volume = {4},
  number = {35},
  pages = {898},
  year = {2019},
  doi = {10.21105/joss.00898}
}

Learn More

Documentation https://atomneb-py.readthedocs.io/
Repository https://github.com/atomneb/AtomNeb-py
Issues & Ideas https://github.com/atomneb/AtomNeb-py/issues
Conda-Forge https://anaconda.org/conda-forge/atomneb
PyPI https://pypi.org/project/atomneb/
DOI 10.21105/joss.02797
Archive 10.5281/zenodo.4287565