malta.utils
===========

.. py:module:: malta.utils


Attributes
----------

.. autoapisummary::

   malta.utils.rel_path


Functions
---------

.. autoapisummary::

   malta.utils.opends
   malta.utils.get_molmass
   malta.utils.get_speciesinfo
   malta.utils.print_speciesinfo
   malta.utils.get_siteinfo
   malta.utils.get_OHfield
   malta.utils.get_O1Dfield
   malta.utils.get_Jfield
   malta.utils.get_transport_directory
   malta.utils.set_climatological_years
   malta.utils.decimal_to_pandas


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

.. py:data:: rel_path
   :value: 'Uninferable'


.. py:function:: opends(fn)

   Open an xarray dataset


.. py:function:: get_molmass(species)

   Gets the molar mass from species_info file


.. py:function:: get_speciesinfo(species)

   Return all info for species in species_info file


.. py:function:: print_speciesinfo(species=None)

   Print all species info in species_info file


.. py:function:: get_siteinfo(site)

   Return info about a site from site_info


.. py:function:: get_OHfield()

   Returns OH field as array


.. py:function:: get_O1Dfield()

   Returns O1D field as array


.. py:function:: get_Jfield(species)

   Returns stratospheric sink for species as array


.. py:function:: get_transport_directory()

   Returns default directory containing transport files


.. py:function:: set_climatological_years(years, trans_dir)

   Finds years where no transport is available and set to climatological trasport.
   This changes the year to read to 1900.

   :param years: Years for which transport is needed.
   :type years: list/array
   :param trans_dir: Directory containing the transport.
   :type trans_dir: string

   :returns: years input with years with no transport set to 1900.
   :rtype: array/list


.. py:function:: decimal_to_pandas(dec, offset_days=0)

   Convert decimal date to pandas datetime

   :param dec: Decimal dates to convert
   :type dec: float

   :returns: List of pandas datetimes
   :rtype: List