STY: updates to export options

[jklenzing]

Description

Updates the pysat export options for operational instruments. Better integration with jklenzing/ops_reach#15

Type of change

• New feature (non-breaking change which adds functionality)

How Has This Been Tested?

via updated unit tests

pytest pysat/tests/test_utils_io.py::TestLoadNetCDF::test_basic_write_and_read_netcdf_export_pysat_info

Test Configuration:

• Operating system: Mac 13.3.1
• Version number: Python 3.10.8

Checklist:

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

If this is a release PR, replace the first item of the above checklist with the release
checklist on the wiki: https://github.com/pysat/pysat/wiki/Checklist-for-Release

[JonathonMSmith]

Wanted to bring this question into the pull request.
Do these items still need to be popped?
We're assigning all of them in the following lines, so maybe they can be left un-popped.

[jklenzing]

I haven't tried swapping these out. Not sure if this is a remnant from python 2.7. acknowledgements and references have to be popped for compatibility with the operational bits below.

[jklenzing]

@JonathonMSmith, I'd like to get this one into the RC if possible. What's the best path forward to address the issues above?

[aburrell]

Are you sure you want to pull this into the RC and re-request all reviews?

[jklenzing]

This is needed for the operational data stuff for REACH

[JonathonMSmith]

I don't know the best path forward. I removed the lines where these variables are popped in my local version of the RC branch and all of the unit tests pass, but I don't know if that's enough. I don't see how any of these attributes could get through without being overwritten because the the assignments on lines 1735-1756 are not conditional, the appear to always occur.

[jklenzing]

My thought is open an issue. We probably want to test this more with existing operational software before removing this code.

[jklenzing]

I don't know the best path forward. I removed the lines where these variables are popped in my local version of the RC branch and all of the unit tests pass, but I don't know if that's enough. I don't see how any of these attributes could get through without being overwritten because the the assignments on lines 1735-1756 are not conditional, the appear to always occur.

I've added #1122 for the next version. We can make a decision then. The rest of this still needs a review.

[JonathonMSmith]

why do references and acknowledgments need to be dropped from the attribute dict unless export_pysat_info is true?

[jklenzing]

why do references and acknowledgments need to be dropped from the attribute dict unless export_pysat_info is true?

I can't actually find where this happens in the code, but acknowledgements and references are transferred to the meta header info while the other pysat properties are not. If I don't pop these, then the unit test will fail since they still exist.

I think it's because these are set during the init function. If I try this on pysat_testing, the other global attrs set here get added automatically.

import pysat
import xarray as xr

test = pysat.Instrument('pysat', 'testing', use_header=True)
test.load(2009, 1)
test.to_netcdf4('./test.nc', export_pysat_info=False)
a = xr.open_dataset('test.nc')

In [13]: a.attrs
Out[13]: 
{'new_thing': 1,
 'test_clean_kwarg': '',
 'test_init_kwarg': '',
 'test_preprocess_kwarg': '',
 'pysat_version': '3.1.0.1rc1',
 'Conventions': 'pysat-simplified SPDF ISTP/IACG for NetCDF',
 'Text_Supplement': '',
 'Date_End': 'Thu, 01 Jan 2009,  2009-01-01T23:59:59.000 UTC',
 'Date_Start': 'Thu, 01 Jan 2009,  2009-01-01T00:00:00.000 UTC',
 'File': ['.', 'test.nc'],
 'File_Date': 'Thu, 01 Jan 2009,  2009-01-01T23:59:59.000 UTC',
 'Generation_Date': '20230509',
 'Logical_File_ID': 'test'}