ENH: TIMED GUVI

[aburrell]

Description

Adds a TIMED GUVI instrument capable of handling the EDR Auroral data. Builds on #147 and so must be merged after that pull request. Additionally, improves testing for the platform modules and generalized support for Imager data processed by JHU APL. Streamlines previous TIMED GUVI loading, ensured all metadata was loaded appropriately, and added a custom flag for time variables, to simplify potential indexing issues.

Although one file is renamed, I did not deprecate it because it was missing from the imports.

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

How Has This Been Tested?

Added a new unit test. Also:

import datetime as dt
import pysat
import pysatNASA

# Load raises logger warnings that "TIME" is not a dimension, as before
guvi = pysat.Instrument(inst_module=pysatNASA.instruments.timed_guvi, tag='edr-aur')
guvi.download(start=dt.datetime(2003, 1, 1))
guvi.load(date=dt.datetime(2003, 1, 1))
print(guvi.variables)

Yields:

['time', 'YEAR', 'DOY', 'LATITUDE', 'LONGITUDE', 'ALTITUDE', 'PIXELSIZE_GEOMAGNETIC_LATITUDE', 'PIXELSIZE_GEOMAGNETIC_LONGITUDE', 'NORTH_DATA', 'SOUTH_DATA', 'NORTH_SWATH_BOUNDARY', 'SOUTH_SWATH_BOUNDARY', 'SOUTH_GEOMAGNETIC_LATITUDE', 'SOUTH_GEOMAGNETIC_LONGITUDE', 'SOUTH_MAGNETIC_LOCAL_TIME', 'SOUTH_GEOGRAPHIC_LATITUDE', 'SOUTH_GEOGRAPHIC_LONGITUDE', 'MODEL_SOUTH_GEOMAGNETIC_LATITUDE', 'MODEL_SOUTH_GEOMAGNETIC_LATITUDE_ERROR', 'MODEL_SOUTH_GEOMAGNETIC_LONGITUDE', 'MODEL_SOUTH_MAGNETIC_LOCAL_TIME', 'MODEL_SOUTH_GEOGRAPHIC_LATITUDE', 'MODEL_SOUTH_GEOGRAPHIC_LONGITUDE', 'SOUTH_POLAR_GEOMAGNETIC_LATITUDE', 'SOUTH_POLAR_GEOMAGNETIC_LONGITUDE', 'SOUTH_POLAR_MAGNETIC_LOCAL_TIME', 'SOUTH_POLAR_GEOGRAPHIC_LATITUDE', 'SOUTH_POLAR_GEOGRAPHIC_LONGITUDE', 'MODEL_SOUTH_POLAR_GEOMAGNETIC_LATITUDE', 'MODEL_SOUTH_POLAR_GEOMAGNETIC_LONGITUDE', 'MODEL_SOUTH_POLAR_MAGNETIC_LOCAL_TIME', 'MODEL_SOUTH_POLAR_GEOGRAPHIC_LATITUDE', 'MODEL_SOUTH_POLAR_GEOGRAPHIC_LONGITUDE', 'SOUTH_DEFAULT_EQUATORWARD_MODEL', 'SOUTH_DATA_QUALITY', 'UT_N', 'NORTH_GEOMAGNETIC_LATITUDE', 'NORTH_GEOMAGNETIC_LONGITUDE', 'NORTH_MAGNETIC_LOCAL_TIME', 'NORTH_GEOGRAPHIC_LATITUDE', 'NORTH_GEOGRAPHIC_LONGITUDE', 'MODEL_NORTH_GEOMAGNETIC_LATITUDE', 'MODEL_NORTH_GEOMAGNETIC_LONGITUDE', 'MODEL_NORTH_GEOMAGNETIC_LATITUDE_ERROR', 'MODEL_NORTH_MAGNETIC_LOCAL_TIME', 'MODEL_NORTH_GEOGRAPHIC_LATITUDE', 'MODEL_NORTH_GEOGRAPHIC_LONGITUDE', 'NORTH_POLAR_GEOMAGNETIC_LATITUDE', 'NORTH_POLAR_GEOMAGNETIC_LONGITUDE', 'NORTH_POLAR_MAGNETIC_LOCAL_TIME', 'NORTH_POLAR_GEOGRAPHIC_LATITUDE', 'NORTH_POLAR_GEOGRAPHIC_LONGITUDE', 'MODEL_NORTH_POLAR_GEOMAGNETIC_LATITUDE', 'MODEL_NORTH_POLAR_GEOMAGNETIC_LONGITUDE', 'MODEL_NORTH_POLAR_MAGNETIC_LOCAL_TIME', 'MODEL_NORTH_POLAR_GEOGRAPHIC_LATITUDE', 'MODEL_NORTH_POLAR_GEOGRAPHIC_LONGITUDE', 'NORTH_DEFAULT_EQUATORWARD_MODEL', 'NORTH_DATA_QUALITY', 'UT_S', 'ELECTRON_MEAN_NORTH_ENERGY_MAP', 'ELECTRON_MEAN_SOUTH_ENERGY_MAP', 'ENERGY_FLUX_NORTH_MAP', 'ENERGY_FLUX_SOUTH_MAP', 'ELECTRON_FLUX_NORTH_BOUNDARY_MAP', 'ELECTRON_FLUX_SOUTH_BOUNDARY_MAP', 'LATITUDE_GEOMAGNETIC_GRID_MAP', 'LONGITUDE_GEOMAGNETIC_NORTH_GRID_MAP', 'LONGITUDE_GEOMAGNETIC_SOUTH_GRID_MAP', 'MLT_GRID_MAP', 'ELECTRON_ENERGY_FLUX_THRESHOLDS', 'HME_NORTH', 'NME_NORTH', 'HME_SOUTH', 'NME_SOUTH', 'PROTON_FLAG_NORTH', 'PROTON_FLAG_SOUTH', 'HEMISPHERE_POWER_NORTH', 'HEMISPHERE_POWER_SOUTH', 'DISK_RADIANCEDATA_INTENSITY_NORTH', 'DISK_DQI_NORTH', 'DISK_RADIANCEDATA_INTENSITY_SOUTH', 'DISK_DQI_SOUTH', 'DATA_QUALITY_GLOBAL', 'AUR_ARC_RADIANCE_NORTH', 'AUR_ARC_RADIANCE_SOUTH', 'AUR_ARC_GROUP_MAP_NORTH', 'AUR_ARC_GROUP_MAP_SOUTH', 'AUR_ARC_MEDIAN_RAD_NORTH', 'AUR_ARC_MEDIAN_RAD_SOUTH', 'AUR_ARC_BOX_VERTEX_NORTH', 'AUR_ARC_BOX_VERTEX_SOUTH', 'AUR_ARC_BOX_ORIENT_NORTH', 'AUR_ARC_BOX_ORIENT_SOUTH', 'MagneticFieldLines']

Test Configuration

• Operating system: OS X BIg Sur
• Version number: Python 3.8
• Any details about your local setup that are relevant: develop branch of pysat

Checklist:

• [x] Make sure you are merging into the develop (not main) branch
• [x] My code follows the style guidelines of this project
• [x] I have performed a self-review of my own code
• [x] I have commented my code, particularly in hard-to-understand areas
• [x] I have made corresponding changes to the documentation
• [x] My changes generate no new warnings
• [x] I have added tests that prove my fix is effective or that my feature works
• [x] New and existing unit tests pass locally with my changes
• [x] Any dependent changes have been merged and published in downstream modules
• [x] Add a note to CHANGELOG.md, summarizing the changes
• [x] Update zenodo.json file for new code contributors

[jklenzing]

@aburrell, flake8 is erroring on an unbalanced bracket. It looks like there were some additional style issues in the merge. I've fixed it locally, running the tests now to see if all works as expected. Checking in to see if you fixed this locally as well before I push.

[aburrell]

@jklenzing the load options don't seem to be resulting in the expected coverage. Is it not doing what I think it's doing?

[jklenzing]

@jklenzing the load options don't seem to be resulting in the expected coverage. Is it not doing what I think it's doing?

The list of tests with optional kwargs looks right for the new guvi data. not sure what is missing.

[jklenzing]

Documented the pysat bug at https://github.com/pysat/pysat/issues/1097