Metadata-Version: 2.1
Name: radis
Version: 0.15.2
Summary: A fast line-by-line code for high-resolution infrared molecular spectra
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,hitemp,exomol,line-by-line
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 :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: astropy>=4.3.1
Requires-Dist: astroquery>=0.4.6
Requires-Dist: beautifulsoup4>=4.10.0
Requires-Dist: cantera>=2.5.1
Requires-Dist: configparser
Requires-Dist: habanero>=1.2.0
Requires-Dist: h5py>=3.2.1
Requires-Dist: joblib
Requires-Dist: lmfit
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: numba
Requires-Dist: pandas
Requires-Dist: plotly>=2.5.1
Requires-Dist: psutil
Requires-Dist: tables
Requires-Dist: scipy>=1.4.0
Requires-Dist: seaborn
Requires-Dist: termcolor
Requires-Dist: specutils
Requires-Dist: lxml
Requires-Dist: hjson
Requires-Dist: publib
Requires-Dist: hitran-api
Requires-Dist: peakutils
Requires-Dist: ruamel.yaml
Requires-Dist: json-tricks>=3.15.0
Requires-Dist: mpldatacursor
Requires-Dist: nvidia-cufft-cu11; sys_platform != "darwin"
Requires-Dist: periodictable
Requires-Dist: vaex-core; python_version < "3.11"
Requires-Dist: vaex-hdf5; python_version < "3.11"
Requires-Dist: vaex-viz; python_version < "3.11"
Provides-Extra: dev
Requires-Dist: numpydoc; extra == "dev"
Requires-Dist: black>=20.8b1; extra == "dev"
Requires-Dist: isort; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: ipython>=7.0.0; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx-autodoc-annotation; extra == "docs"
Requires-Dist: sphinx_autodoc_defaultargs>=0.1.2; extra == "docs"
Requires-Dist: sphinx>=1.7.0; extra == "docs"
Requires-Dist: astroquery>=0.3.9; extra == "docs"
Requires-Dist: sphinxcontrib-apidoc; extra == "docs"
Requires-Dist: sphinx-gallery; extra == "docs"
Requires-Dist: lmfit; extra == "docs"
Requires-Dist: pytest; extra == "docs"

> | [![PyPI](https://img.shields.io/pypi/v/radis.svg)](https://pypi.python.org/pypi/radis)
>   [![Downloads](https://img.shields.io/pypi/dw/radis.svg)](https://pypistats.org/packages/radis)
>   [![Article](https://zenodo.org/badge/doi/10.1016/j.jqsrt.2018.09.027.svg)](https://linkinghub.elsevier.com/retrieve/pii/S0022407318305867)
>   [![Spectral Synthesis Algorithm](https://zenodo.org/badge/doi/10.1016/j.jqsrt.2020.107476.svg)](https://linkinghub.elsevier.com/retrieve/pii/S0022407320310049)
>   [![Documentation Status](https://readthedocs.org/projects/radis/badge/)](https://readthedocs.org/projects/radis/)
>   [![https://radis.github.io/radis-lab/](https://mybinder.org/badge.svg)](https://radis.github.io/radis-lab/)
> | [![Slack](https://img.shields.io/badge/slack-join-green.svg?logo=slack)](https://radis.github.io/slack-invite/)
>   [![Contributors](https://img.shields.io/github/contributors/radis/radis.svg)](https://github.com/radis/radis/graphs/contributors)
>   [![Tests](https://app.travis-ci.com/radis/radis.svg?branch=develop)](https://app.travis-ci.com/github/radis/radis)
>   [![Coverage](https://codecov.io/gh/radis/radis/branch/develop/graph/badge.svg)](https://codecov.io/gh/radis/radis)
>   [![Code Quality](https://img.shields.io/lgtm/grade/python/g/radis/radis.svg?logo=lgtm&logoWidth=18))](https://lgtm.com/projects/g/radis/radis/alerts)
>   [![Benchmarks](http://img.shields.io/badge/benchmarked%20by-asv-blue.svg?style=flat)](https://github.com/radis/radis-benchmark)
>   [![License](https://img.shields.io/badge/License-LGPL3-blue.svg)](./License.md)

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

RADIS is a fast line-by-line code for high resolution infrared molecular
spectra (emission / absorption, equilibrium / non-LTE) based on
HITRAN/HITEMP/ExoMol.

It includes post-processing tools to compare experimental spectra and
spectra calculated with RADIS or other spectral codes.

User full documentation (advanced install and examples) are available on
the [RADIS Website](http://radis.readthedocs.io/).

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

### Install

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

    pip install radis

or `mamba` or `conda` via the conda-forge channel:

    conda install radis -c conda-forge

**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/dev/developer.html#label-install)
.

### Quick Start

Calculate a CO equilibrium spectrum from the HITRAN database :

    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
                      databank='hitran'   # or 'hitemp'
                      )
    s.apply_slit(0.5, 'nm')       # simulate an experimental slit
    s.plot('radiance')

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

### Advanced use

The Quick Start examples automatically downloads the line databases from
[HITRAN-2016](https://radis.readthedocs.io/en/latest/references/references.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/references/references.html#hitemp-2010)
(typically T \< 2000 K) or
[CDSD-4000](https://radis.readthedocs.io/en/latest/references/references.html#cdsd-4000)
(T \< 5000 K). HITEMP can also be downloaded automatically, or can be
downloaded manually and described in a `~/radis.json` [Configuration
file](https://radis.readthedocs.io/en/latest/lbl/lbl.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.

### Compare with experiments

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 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/examples.html)
section for more examples, and to the [Spectrum
page](https://radis.readthedocs.io/en/latest/spectrum/spectrum.html) for
more post-processing functions.

### GPU Acceleration

RADIS supports GPU acceleration for super-fast computation of spectra.
Refer to [GPU Spectrum Calculation on
RADIS](https://radis.readthedocs.io/en/latest/lbl/lbl.html#calculating-spectrum-using-gpu)
for more details on GPU acceleration.:

    =======================================

#### Try online (no installation needed!)

🌱 Radis-app \-\-\-\-\-\-\-\--

A simple [web-app](https://radis.app/) for RADIS under development -
[GitHub](https://github.com/suzil/radis-app)

[![https://radis.app/](https://user-images.githubusercontent.com/16088743/103406077-b2457100-4b59-11eb-82c0-e4de027a91c4.png)](https://radis.app/)

🔬 RADIS-lab \-\-\-\-\-\-\-\--

An [online environment](https://github.com/radis/radis-lab) for advanced
spectrum processing and comparison with experimental data:

-   no need to install anything
-   use pre-configured line databases (HITEMP)
-   upload your data files, download your results !

[![https://radis.github.io/radis-lab/](https://user-images.githubusercontent.com/16088743/103448773-7d8f0200-4c9e-11eb-8bf1-ce3385519b77.png)](https://radis.github.io/radis-lab/)

See more [on GitHub](https://github.com/radis/radis-lab)

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

Cite
----

Articles are available at
[![Article](https://zenodo.org/badge/doi/10.1016/j.jqsrt.2018.09.027.svg)](https://linkinghub.elsevier.com/retrieve/pii/S0022407318305867)
[![Spectral Synthesis Algorithm](https://zenodo.org/badge/doi/10.1016/j.jqsrt.2020.107476.svg)](https://linkinghub.elsevier.com/retrieve/pii/S0022407320310049)

For reproducibility, do not forget to cite the line database used, and
the spectroscopic constants if running nonequilibrium calculations. See
[How to
cite?](https://radis.readthedocs.io/en/latest/references/references.html#cite)

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

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

### Contribute

Want to contribute to RADIS? Join the Slack community and we\'ll help
you through the process. Want to get started immediatly? Nice. Have a
look at the the [Developer
Guide](https://radis.readthedocs.io/en/latest/dev/developer.html).

[![Contributors](https://img.shields.io/github/contributors/radis/radis.svg)](https://github.com/radis/radis/graphs/contributors)
[![Slack](https://img.shields.io/badge/slack-join-green.svg?logo=slack)](https://radis.github.io/slack-invite/)

RADIS internals are also described in the [full
documentation](https://radis.readthedocs.io/en/latest/index.html)

### 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.md)

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

References
----------

### Links

-   Documentation:
    [![Documentation Status](https://readthedocs.org/projects/radis/badge/)](https://readthedocs.org/projects/radis/)
-   Help:
    [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/radis-radiation/community)
    [![Slack](https://img.shields.io/badge/slack-join-green.svg?logo=slack)](https://radis.github.io/slack-invite/)
    [Q&A forum](https://groups.google.com/forum/#!forum/radis-radiation)
-   Articles:
    [![Article](https://zenodo.org/badge/doi/10.1016/j.jqsrt.2018.09.027.svg)](https://linkinghub.elsevier.com/retrieve/pii/S0022407318305867)
    [![Spectral Synthesis Algorithm](https://zenodo.org/badge/doi/10.1016/j.jqsrt.2020.107476.svg)](https://linkinghub.elsevier.com/retrieve/pii/S0022407320310049)
-   Source Code:
    [![GitHub](https://img.shields.io/github/stars/radis/radis.svg?style=social&label=Star)](https://github.com/radis/radis/stargazers)
    [![Contributors](https://img.shields.io/github/contributors/radis/radis.svg)](https://github.com/radis/radis/graphs/contributors)
    [![License](https://img.shields.io/badge/License-LGPL3-blue.svg)](./License.md)
-   Test Status:
    [![Tests](https://app.travis-ci.com/radis/radis.svg?branch=develop)](https://app.travis-ci.com/github/radis/radis)
    [![Coverage](https://codecov.io/gh/radis/radis/branch/develop/graph/badge.svg)](https://codecov.io/gh/radis/radis)
    [![Benchmarks](http://img.shields.io/badge/benchmarked%20by-asv-blue.svg?style=flat)](https://github.com/radis/radis-benchmark)
-   PyPi Repository:
    [![PyPI](https://img.shields.io/pypi/v/radis.svg)](https://pypi.python.org/pypi/radis)
    [![Downloads](https://img.shields.io/pypi/dw/radis.svg)](https://pypistats.org/packages/radis)
-   Interactive Examples:
    [radis\_examples](https://github.com/radis/radis-examples)
    [![Examples](https://img.shields.io/github/stars/radis/radis-examples.svg?style=social&label=Star)](https://github.com/radis/radis-examples)
    [![https://radis.github.io/radis-lab/](https://mybinder.org/badge.svg)](https://radis.github.io/radis-lab/)
-   [Fitroom](https://github.com/radis/fitroom) (for advanced
    multidimensional fitting).

### Other Spectroscopic tools

See [awesome-spectra](https://github.com/erwanp/awesome-spectra)
[![Examples](https://img.shields.io/github/stars/erwanp/awesome-spectra.svg?style=social&label=Star)](https://github.com/erwanp/awesome-spectra)

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

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