cassis_lte_python.database.species
==================================

.. py:module:: cassis_lte_python.database.species


Classes
-------

.. autoapisummary::

   cassis_lte_python.database.species.Species


Functions
---------

.. autoapisummary::

   cassis_lte_python.database.species.get_species_thresholds
   cassis_lte_python.database.species.get_partition_function
   cassis_lte_python.database.species.get_partition_function_tex
   cassis_lte_python.database.species.get_species_info


Module Contents
---------------

.. py:class:: Species(tag, ntot=700000000000000.0, tex=100.0, fwhm=None, component=None)

   .. py:attribute:: pf


   .. py:method:: as_json()


   .. py:property:: id


   .. py:property:: name


   .. py:property:: database


   .. py:property:: tag


   .. py:property:: ntot


   .. py:property:: tex


   .. py:property:: fwhm


   .. py:property:: parameters


   .. py:method:: set_component(comp_name)


   .. py:method:: get_partition_function(tex)


.. py:function:: get_species_thresholds(sp_threshold_infos: list | dict | str | os.PathLike, select_species=None, return_list_sp=False)

   Determine thresholds for the species to be modeled or plotted.

   :param sp_threshold_infos: can either be :

       - a list : thresholds will be the default ones
       - a dictionary : the list of species is extracted and the thresholds completed with default values if needed
       - a path : the list of species and their thresholds are read from a file

   :param select_species: a subset of species for which the thresholds are wanted
   :param return_list_sp: return the list of species as well as the thresholds
   :return:


.. py:function:: get_partition_function(tag, db=None, temp=None)

.. py:function:: get_partition_function_tex(tref, qlog, temp, tag='')

   Interpolate the partition function at the desired temp, if temp is w/i the min/max of the database values.
   Interpolation is done on a log-log scale.

   :param tref: database values for the temperature
   :param qlog: log10 of the partition function for the values in tref
   :param temp: temperature at which the partition function is desired
   :param tag: tag of the species
   :return: interpolated partition function at temp


.. py:function:: get_species_info(tag: str, database=None)