Introduces new classes that hold equatorial auroral boundary data (EAB) and dual-boundary data. Dual-boundary coordinate support has been propagated throughout all module functions. Added a function to identify data along a satellite track to support DMSP SSJ boundaries. Improved testing coverage, partially addressing #79. Added the new IMAGE files and updated the acceptance criteria, addressing #103. Updated the documentation for the changes and added new examples.
Type of change
Please delete options that are not relevant.
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?
New unit tests and documentation examples.
[x] EAB unit tests
[x] Dual Boundary unit tests
[x] Dual Boundary calls to instrument modules
[x] New classes in docs
[x] New modules in docs
[x] EAB example in docs
[x] Dual-boundary example in docs
[x] Dual-boundary vector example in docs
Test Configuration:
Operating system: OS X Big Sur
Version number: Python 3.8, 3.9
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 commits are formatted appropriately (following the SciPy/NumPy style)
[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
[N/A] 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.rst, summarising the changes
Coverage increased (+16.8%) to 93.677% when pulling d1fe95f409143f683cf6e46ae320debdece45fd2 on auroral_scaling into e57e12c3c2897bf6f89f62e655086edf500dcee7 on develop.
Description
Introduces new classes that hold equatorial auroral boundary data (EAB) and dual-boundary data. Dual-boundary coordinate support has been propagated throughout all module functions. Added a function to identify data along a satellite track to support DMSP SSJ boundaries. Improved testing coverage, partially addressing #79. Added the new IMAGE files and updated the acceptance criteria, addressing #103. Updated the documentation for the changes and added new examples.
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
New unit tests and documentation examples.
Test Configuration:
Checklist:
develop
(notmain
) branchChangelog.rst
, summarising the changesAUTHORS.rst