pyValEIA.utils.conjunctions
NIMO conjunction functions.
Functions
|
Set the Swarm satellite altitude. |
|
Find conjunctions between a model and Swarm. |
|
Find conjunctions between a model and Madrigal data. |
Module Contents
- pyValEIA.utils.conjunctions.set_swarm_alt(sat_id)[source]
Set the Swarm satellite altitude.
- Parameters:
- sat_idstr
Satellite ID, expects one of ‘A’, ‘B’, or ‘C’
- Returns:
- sat_altfloat
Satellite altitude in km
- pyValEIA.utils.conjunctions.swarm_conjunction(mod_dc, swarm_check, alt_str='hmf2', inc=0, max_tdif=15, offset=0)[source]
Find conjunctions between a model and Swarm.
- Parameters:
- mod_dcdict
Dictionary of model data
- swarm_checkpd.DataFrame
DataFrame of Swarm data
- alt_str: str kwarg
‘A’, ‘B’, ‘C’ or ‘hmf2’ for altitude (default=’hmf2’)
- incint
Increase altitude by specified incriment in km (default=0)
- max_tdifdouble nkwarg
Maximum time distance (in minutes) between a NIMO and Swarm conjunction allowed (default=15)
- offsetint
Number of days beyond the loaded Swarm period to check (default=0)
- Returns:
- mod_dfpd.DataFrame
NIMO data at Swarm location/time
- mod_mapdict
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
- pyValEIA.utils.conjunctions.mad_conjunction(mod_dc, mlat_val, glon_val, stime, max_tdif=20, mad_tres=5)[source]
Find conjunctions between a model and Madrigal data.
- Parameters:
- mod_dcdict
Dictionary of model data
- mlat_valdouble
+/- magnetic latitude
- glon_valdouble
Geographic longitude of conjunction
- stimedt.datetime
Datetime for conjunction
- max_tdifint
Maximum time difference in minutes (default=20)
- mad_tresint
Time resolution of the Madrigal TEC data in minutes (default=5)
- Returns:
- mod_dfpd.DataFrame
NIMO data at Madrigal location/time
- mod_mapdict
Dictionary of 2D arrays of TEC, geo lon, and geo lat for map plots