.. image:: https://img.shields.io/badge/python-3.6+-blue.svg :target: https://www.python.org/downloads/release/python-360/ :alt: Python 3.6+ .. image:: https://travis-ci.org/jason-neal/eniric.svg?branch=master :target: https://travis-ci.org/jason-neal/eniric :alt: Build Status .. image:: https://coveralls.io/repos/github/jason-neal/eniric/badge.svg?branch=master :target: https://coveralls.io/github/jason-neal/eniric?branch=master :alt: Coverage Status .. image:: https://api.codacy.com/project/badge/Grade/24d3d525a79d4ae493de8c527540edef :target: https://www.codacy.com/app/jason-neal/eniric?utm_source=github.com&utm_medium=referral&utm_content=jason-neal/eniric&utm_campaign=badger :alt: Codacy Badge .. image:: https://badge.fury.io/py/eniric.svg :target: https://badge.fury.io/py/eniric :alt: PyPI version .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.2658917.svg :target: https://doi.org/10.5281/zenodo.2658917 .. image:: http://joss.theoj.org/papers/10.21105/joss.01053/status.svg :target: https://doi.org/10.21105/joss.01053 ================================== Welcome to Eniric's documentation! ================================== .. toctree:: :maxdepth: 1 :caption: Contents: installation configuration basic_usage broadening telluric_correction normalization resampling theoretical_precision scripts examples utilities ``Eniric`` is a Python 3.6+ software written to calculate the theoretical Radial Velocity (RV) precision of Near-InfraRed (NIR) stellar spectra. ``Eniric`` is an overhaul and extension to the code initially used in `Figueira et al. 2016`_ to analysis the precision of M-dwarf stars in the NIR, extending its ability to use any synthetic spectra from the PHOENIX-ACES and BT-Settl libraries, or user provided spectra, and making it easier and faster to use. Extending the performance and usability, it is able to be used on any synthetic spectra from the `PHOENIX-ACES`_ and `BT-Settl`_ (CIFIST2011-2015) libraries. To get started see the :doc:`Installation <./installation>`, or the :doc:`Basic Usage <./basic_usage>`. Features -------- ``Eniric`` contains a number of tools to transform and analyse synthetic or observed spectra. * :doc:`Spectral broadening <./broadening>`: Allows for Rotational and Instrumental broadening of synthetic spectra given a rotation speed ``vsini`` and resolution ``R``. * :doc:`Atmospheric transmission ` masking: Analyzing the RV precision attainable under the different masking conditions presented in `Figueira et al. 2016`_. The three conditions specifically treated are: * No contamination or treatment of atmospheric transmission * Masking all regions affected by atmospheric absorption of a given depth % over the course of the year. * Assuming perfect telluric correction in which the variance of the measured flux is impacted. * Spectral :doc:`Resampling ` Allows for resampling of synthetic spectra to ``N`` pixels per FWHM. Default is 3. * :doc:`SNR normalization ` Normalize spectral flux to a defined SNR level. * Photometric band selection Analysis splitable into individual photometric bands ``Z``\ , ``Y``\ , ``J``\ , ``H``\ , ``K``. User definable. * :doc:`Theoretical RV precision ` Compute spectral RV precision and spectral quality. * Incremental quality/precision Determine the RV precision and spectral quality on narrow wavelength slices across the entire spectrum, similar to that present in Figure 1 of both `Bouchy et al.(2001) `_ and `Artigau et al. (2018) `_. * Analyse relative precision of synthetic libraries The RV precision of are present relative to a specified SNR per pixel in the center of a photometric band. The default as used in `Figueira et al. 2016`_ is a SNR of 100 at the center of the J-band. - Available through Starfish's `grid_tools `_. - `PHOENIX-ACES`_ - `BT-Settl`_ .. figure:: _static/precisions.png :target: https://github.com/jason-neal/eniric/blob/master/paper/precisions.png :alt: Example relative precisions :align: center Precision achieved with ``eniric`` as a function of spectral band for stars with a rotational velocity of vsini=1.0 km/s and temperatures 3900 K, 3500 K, 2800 K, 2600 K, corresponding to spectral types M0, M3, M6, and M9 respectively. The dashed line represents the theoretical limits imposed by condition 1, and the filled area represents the values within the limits set by conditions 2 (circles) and 3 (triangles); blue, green, and red represent the results obtained for resolutions of 60000, 80000, and 100000, respectively. The spectra were normalized to have a SNR of 100 per resolution element as measured at the center of the J-band. This is similar to Figure 1 from `Figueira et al. 2016`_ but with updated precision values. Background ---------- The theoretical background and first version of the code used in Eniric was presented in `Figueira et al. 2016`_. .. code-block:: text P. Figueira, V. Zh. Adibekyan, M. Oshagh, J. J. Neal, B. Rojas-Ayala, C. Lovis, C. Melo, F. Pepe, N. C. Santos, M. Tsantaki, 2016, Radial velocity information content of M dwarf spectra in the near-infrared, Astronomy and Astrophysics, 586, A101 After :ref:`install_ref` and :ref:`config_ref` the updated results for `Figueira et al. 2016`_ can be reproduced by ``eniric`` with the following command. .. code-block:: bash phoenix_precision.py -t 3900 3500 2800 2600 -l 4.5 -m 0.0 -r 60000 80000 100000 -v 1.0 5.0 10.0 -b Z Y J H K Support ------- If you are having issues, please let us know. You can submit an issue on `Github `_. License ------- The project is licensed under the `MIT License `_. Indices and tables ^^^^^^^^^^^^^^^^^^ * :ref:`genindex` * :ref:`modindex` * :ref:`search` .. _`Figueira et al. 2016`: http://dx.doi.org/10.1051/0004-6361/201526900 .. _`PHOENIX-ACES`: http://phoenix.astro.physik.uni-goettingen.de .. _`BT-Settl`: https://phoenix.ens-lyon.fr/Grids/BT-Settl/CIFIST2011_2015/FITS/