pyValEIA.utils.conjunctions
===========================

.. py:module:: pyValEIA.utils.conjunctions

.. autoapi-nested-parse::

   NIMO conjunction functions.

   ..
       !! processed by numpydoc !!


Functions
---------

.. autoapisummary::

   pyValEIA.utils.conjunctions.set_swarm_alt
   pyValEIA.utils.conjunctions.swarm_conjunction
   pyValEIA.utils.conjunctions.mad_conjunction


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

.. py:function:: set_swarm_alt(sat_id)

   
   Set the Swarm satellite altitude.


   :Parameters:

       **sat_id** : str
           Satellite ID, expects one of 'A', 'B', or 'C'



   :Returns:

       **sat_alt** : float
           Satellite altitude in km











   ..
       !! processed by numpydoc !!

.. py:function:: swarm_conjunction(mod_dc, swarm_check, alt_str='hmf2', inc=0, max_tdif=15, offset=0)

   
   Find conjunctions between a model and Swarm.


   :Parameters:

       **mod_dc** : dict
           Dictionary of model data

       **swarm_check** : pd.DataFrame
           DataFrame of Swarm data

       **alt_str: str kwarg**
           'A', 'B', 'C' or 'hmf2' for altitude (default='hmf2')

       **inc** : int
           Increase altitude by specified incriment in km (default=0)

       **max_tdif** : double nkwarg
           Maximum time distance (in minutes) between a NIMO and Swarm
           conjunction allowed (default=15)

       **offset** : int
           Number of days beyond the loaded Swarm period to check (default=0)



   :Returns:

       **mod_df** : pd.DataFrame
           NIMO data at Swarm location/time

       **mod_map** : dict
           Dictionary of 2D arrays of NmF2, geo lon, and geo lat prepared for
           map plots




   :Raises:

       ValueError
           If NIMO time and starting Swarm time are more than `max_tdif` apart

       ValueError
           If Swarm altitude is greater than 600 km







   ..
       !! processed by numpydoc !!

.. py:function:: mad_conjunction(mod_dc, mlat_val, glon_val, stime, max_tdif=20, mad_tres=5)

   
   Find conjunctions between a model and Madrigal data.


   :Parameters:

       **mod_dc** : dict
           Dictionary of model data

       **mlat_val** : double
           +/- magnetic latitude

       **glon_val** : double
           Geographic longitude of conjunction

       **stime** : dt.datetime
           Datetime for conjunction

       **max_tdif** : int
           Maximum time difference in minutes (default=20)

       **mad_tres** : int
           Time resolution of the Madrigal TEC data in minutes (default=5)



   :Returns:

       **mod_df** : pd.DataFrame
           NIMO data at Madrigal location/time

       **mod_map** : dict
           Dictionary of 2D arrays of TEC, geo lon, and geo lat for map plots











   ..
       !! processed by numpydoc !!