Metadata-Version: 2.1
Name: radis
Version: 0.9.21
Summary: A non-equilibrium Radiative Solver for HITRAN-like database species 
Home-page: https://github.com/radis/radis
Author: Erwan Pannier
Author-email: erwan.pannier@gmail.com
License: GNU Lesser General Public License v3 (LGPLv3)
Keywords: spectrum,infrared,spectra,radiation,nonequilibrium,spectroscopy,molecules,HITRAN
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Topic :: Scientific/Engineering
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.6
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: mpldatacursor
Requires-Dist: pint (>=0.7.2)
Requires-Dist: publib (>=0.3.2)
Requires-Dist: plotly (>=2.5.1)
Requires-Dist: termcolor
Requires-Dist: six
Requires-Dist: configparser
Requires-Dist: astroquery (>=0.3.9)
Requires-Dist: json-tricks
Requires-Dist: numpydoc
Requires-Dist: tables
Requires-Dist: pytest
Requires-Dist: h5py
Requires-Dist: joblib
Requires-Dist: numba

[![PyPI](https://img.shields.io/pypi/v/radis.svg)](https://pypi.python.org/pypi/radis)

[![License](https://img.shields.io/badge/License-LGPL3-blue.svg)](./License)

[![Article](https://zenodo.org/badge/doi/10.1016/j.jqsrt.2018.09.027.svg)](https://linkinghub.elsevier.com/retrieve/pii/S0022407318305867)

[![Tests](https://img.shields.io/travis/radis/radis.svg)](https://travis-ci.org/radis/radis)

[![Coverage](https://codecov.io/gh/radis/radis/branch/master/graph/badge.svg)](https://codecov.io/gh/radis/radis)

[![Documentation Status](https://readthedocs.org/projects/radis/badge/)](https://radis.readthedocs.io/en/latest/?badge=latest)

[![https://mybinder.org/v2/gh/radis/radis-examples/master?filepath=radis\_online.ipynb](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/radis/radis-examples/master?filepath=radis_online.ipynb)

[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/radis-radiation/community)

[RADIS](https://radis.readthedocs.io/)
======================================

A nonequilibrium infrared emission and absorption line-by-line code & a
post-processing library to compare experimental and calculated spectra.

User guide, install procedure and examples are available on the [RADIS
Website](http://radis.readthedocs.io/):

[![Documentation Status](https://readthedocs.org/projects/radis/badge/)](https://radis.readthedocs.io/en/latest/?badge=latest)

Getting Started
---------------

### Install

Assuming you have Python installed with the
[Anaconda](https://www.anaconda.com/download/) distribution just use:

    pip install radis 

**That\'s it!** You can now run your first example below. If you
encounter any issue, or to upgrade the package later, please refer to
the [detailed installation
procedure](https://radis.readthedocs.io/en/latest/install.html#label-install)
.

### Quick Start

Calculate a CO equilibrium spectrum from the HITRAN database, using the
[calc\_spectrum](https://radis.readthedocs.io/en/latest/source/radis.lbl.calc.html#radis.lbl.calc.calc_spectrum)
function. Output is a [Spectrum
object](https://radis.readthedocs.io/en/latest/spectrum/spectrum.html#label-spectrum):
:

    from radis import calc_spectrum
    s = calc_spectrum(1900, 2300,         # cm-1
                      molecule='CO',
                      isotope='1,2,3',
                      pressure=1.01325,   # bar
                      Tgas=700,           # K
                      mole_fraction=0.1, 
                      path_length=1,      # cm
                      )
    s.apply_slit(0.5, 'nm')       # simulate an experimental slit
    s.plot('radiance')

![](https://radis.readthedocs.io/en/latest/_images/co_spectrum_700K.png)

Calculate a CO *nonequilibrium* spectrum from the HITRAN database (on
your first call, this will calculate and cache the CO(X) rovibrational
energies): :

    s2 = calc_spectrum(1900, 2300,         # cm-1
                      molecule='CO',
                      isotope='1,2,3',
                      pressure=1.01325,   # bar
                      Tvib=700,           # K
                      Trot=300,           # K
                      mole_fraction=0.1, 
                      path_length=1,      # cm
                      )
    s2.apply_slit(0.5, 'nm')
    s2.plot('radiance', nfig='same')    # compare with previous

The Quick Start examples automatically download the line databases from
[HITRAN-2016](https://radis.readthedocs.io/en/latest/bibliography.html#hitran-2016),
which is valid for temperatures below 700 K. For *high temperature*
cases, you may need to use other line databases such as
[HITEMP-2010](https://radis.readthedocs.io/en/latest/bibliography.html#hitemp-2010)
(typically T \< 2000 K) or
[CDSD-4000](https://radis.readthedocs.io/en/latest/bibliography.html#cdsd-4000)
(T \< 5000 K). These databases must be described in a `~/.radis`
[Configuration
file](https://radis.readthedocs.io/en/latest/lbl/index.html#label-lbl-config-file).

More complex
[examples](https://radis.readthedocs.io/en/latest/examples.html#label-examples)
will require to use the
[SpectrumFactory](https://radis.readthedocs.io/en/latest/source/radis.lbl.factory.html#radis.lbl.factory.SpectrumFactory)
class, which is the core of RADIS line-by-line calculations.
[calc\_spectrum](https://radis.readthedocs.io/en/latest/source/radis.lbl.calc.html#radis.lbl.calc.calc_spectrum)
is a wrapper to
[SpectrumFactory](https://radis.readthedocs.io/en/latest/source/radis.lbl.factory.html#radis.lbl.factory.SpectrumFactory)
for the simple cases.

Experimental spectra can be loaded using the
[experimental\_spectrum](https://radis.readthedocs.io/en/latest/source/radis.spectrum.models.html#radis.spectrum.models.experimental_spectrum)
function and compared with the
[plot\_diff](https://radis.readthedocs.io/en/latest/source/radis.spectrum.compare.html#radis.spectrum.compare.plot_diff)
function. For instance:

    from numpy import loadtxt
    from radis import experimental_spectrum, plot_diff
    w, I = loadtxt('my_file.txt').T    # assuming 2 columns 
    sexp = experimental_spectrum(w, I, Iunit='mW/cm2/sr/nm')
    plot_diff(sexp, s)    # comparing with previously spectrum 's' calculated previously 

Typical output of
[plot\_diff](https://radis.readthedocs.io/en/latest/source/radis.spectrum.compare.html#radis.spectrum.compare.plot_diff):

[![https://radis.readthedocs.io/en/latest/\_images/cdsd4000\_vs\_hitemp\_3409K.svg](docs/spectrum/cdsd4000_vs_hitemp_3409K.svg)](https://radis.readthedocs.io/en/latest/spectrum/spectrum.html#compare-two-spectra)

Refer to the
[Examples](https://radis.readthedocs.io/en/latest/examples.html#label-examples)
section for more examples, and to the [Spectrum
page](https://radis.readthedocs.io/en/latest/spectrum/spectrum.html#label-spectrum)
for more post-processing functions.

### In the browser (no installation needed!)

Alternatively, you can also run RADIS directly in the browser with the
[RADIS Interactive
Examples](https://github.com/radis/radis-examples#interactive-examples)
project. For instance, run the Quick Start example on the link below:

[![https://mybinder.org/v2/gh/radis/radis-examples/master?filepath=first\_example.ipynb](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/radis/radis-examples/master?filepath=first_example.ipynb)

Or start a bare RADIS online session:

[![https://mybinder.org/v2/gh/radis/radis-examples/master?filepath=radis\_online.ipynb](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/radis/radis-examples/master?filepath=radis_online.ipynb)

------------------------------------------------------------------------

Developer Guide
---------------

### Architecture

RADIS internals are described in the [Developer
Guide](https://radis.readthedocs.io/en/latest/developer.html) :

[![](https://radis.readthedocs.io/en/latest/_images/RADIS_flow_chart.svg)](https://radis.readthedocs.io/en/latest/dev/architecture.html#label-dev-architecture)

### License

The code is available on this repository under [GNU LESSER GENERAL
PUBLIC LICENSE (v3)](./LICENSE)

[![License](https://img.shields.io/badge/License-LGPL3-blue.svg)](./License)

### Support

If encountering any problem, first refer to the list of known
[Issues](https://github.com/radis/radis/issues?utf8=%E2%9C%93&q=is%3Aissue)
on GitHub. We appreciate your feedback and suggestions!

For any question, please join the discussion channel on Gitter:

[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/radis-radiation/community)

------------------------------------------------------------------------

References
----------

### Links

RADIS:

-   Documentation: <http://radis.readthedocs.io/>

    [![Documentation Status](https://readthedocs.org/projects/radis/badge/)](https://radis.readthedocs.io/en/latest/?badge=latest)

-   Source Code: <https://github.com/radis/radis>
-   Article:
    <https://linkinghub.elsevier.com/retrieve/pii/S0022407318305867>

    [![Article](https://zenodo.org/badge/doi/10.1016/j.jqsrt.2018.09.027.svg)](https://linkinghub.elsevier.com/retrieve/pii/S0022407318305867)

And also:

-   Test Status: <https://travis-ci.org/radis/radis>

    [![Tests](https://img.shields.io/travis/radis/radis.svg)](https://travis-ci.org/radis/radis)

-   Test Coverage: <https://codecov.io/gh/radis/radis>

    [![Coverage](https://codecov.io/gh/radis/radis/branch/master/graph/badge.svg)](https://codecov.io/gh/radis/radis)

-   PyPi Repository: <https://pypi.org/project/radis/>

    [![PyPI](https://img.shields.io/pypi/v/radis.svg)](https://pypi.python.org/pypi/radis)

-   Interactive Examples: <https://github.com/radis/radis-examples>

### Other Spectroscopic tools

------------------------------------------------------------------------

[![RADIS logo](https://github.com/radis/radis/blob/master/docs/radis_ico.png)](https://radis.readthedocs.io/)


