ENH: ACE data

[jklenzing]

Description

Addresses #127

Adds data for ACE L2 data. L1 data is managed at pysatSpaceWeather, so these need unique names to avoid messing with the registry. Adding '_l2' to each name to signify Level 2.

Type of change

• New feature (non-breaking change which adds functionality)
• This change requires a documentation update

How Has This Been Tested?

Tested locally via pytest.

Test Configuration

• Operating system: Mac OS X Monterrey
• Version number: python 3.8.11

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]

Pinging @aburrell for a review

[jklenzing]

Why is test.nc included?

test.nc was accidentally committed. Removed.

[aburrell]

Ok, I just went to play with the data, and there's no information on which of the inst_id values I should pick. This could be in the module docstrings or (if more appropriate) these could be tags instead of inst_ids and have little descriptions.

[jklenzing]

I like the idea of changing these to tags. I have yet to find descriptions of the products in the online docs. I'll poke around a little more.

[aburrell]

Comparing the CDF and HDF directory structures I'm going to guess it's related to the 1day, 1hr, 3min, 12sec, and 27day products?

[jklenzing]

Comparing the CDF and HDF directory structures I'm going to guess it's related to the 1day, 1hr, 3min, 12sec, and 27day products?

Looking at the descriptions on the main page(https://cdaweb.gsfc.nasa.gov/, search for ACE), that matches the descriptions. I'll update the tag names with the cadence since h1, k0, etc seems to be an internal SPDF organization thing rather than part of the data product.

[jklenzing]

Here's my current proposed structure:

platform = 'ace'
name = 'epam_l2'
tags = {'level2': 'ACE/EPAM Solar Energetic Particle Level 2 Data',
        'key': 'ACE/EPAM Solar Energetic Particle Key Parameters'}
inst_ids = {'12sec': ['level2'],
            '5min': ['key', 'level2'],
            '1hr': ['key', 'level2']}

The 'h' from the old version refers to the level 2 data, 'k' to 'key parameters'. Note that the key parameter product does not exist for every time cadence.

I have a working version for EPAM, but ultimately this will be easier if #145 is finished and merged in, since we can pull remote file names in directly from cdasws. Pinging @JonathonMSmith for thoughts.

[jklenzing]

Fixing the ref / property order here so I can clean up the rest of the code in parallel.

[aburrell]

The metadata is a bit messed up. There are double values for 'fill', for instance, which could be cleaned up to make the data easier to handle:

swepam.meta['Np']

units                                                         #/cc
long_name                                                H_Density
notes                                                             
desc                                                              
value_min                                                      NaN
value_max                                                      NaN
fill                                                           NaN
plot_label                                                        
axis                                                              
scale                                                       linear
FIELDNAM                                        Proton No. density
DICT_KEY                                            density>number
CATDESC                   Solar Wind Proton Number Density, scalar
standard_name                                   Proton No. density
VALIDMIN0                                                     -1.0
VALIDMIN1                                                     -1.0
VALIDMIN2                                                     -1.0
VALIDMAX0                                                     -1.0
VALIDMAX1                                                     -1.0
VALIDMAX2                                                     -1.0
SCALEMIN0                                                     -1.0
SCALEMIN1                                                     -1.0
SCALEMIN2                                                     -1.0
SCALEMAX0                                                     -1.0
SCALEMAX1                                                     -1.0
SCALEMAX2                                                     -1.0
FORM_PTR                                                          
LABL_PTR_1                                                        
UNIT_PTR                                                          
FILLVAL                                              -2147483648.0
SCALETYP                                                          
VALIDMIN                                                       0.0
VALIDMAX                                                     200.0
SCALEMIN                                                       0.0
SCALEMAX                                                     100.0
LABLAXIS                                                 H_Density
AVG_TYPE                                                          
VAR_NOTES        Np is the proton number density in units of cm...
children                                                      None
Name: Np, dtype: object

[jklenzing]

Updated with the meta_translation to convert the metadata.

[jklenzing]

Created a standard clean routine to pass through to each ace instrument. Ready for re-review.