aburrell / ocbpy

Convert between magnetic and adaptive, polar boundary coordinates

BSD 3-Clause "New" or "Revised" License

7 stars 7 forks source link

Image doc update #111

Closed aburrell closed 2 years ago

aburrell commented 2 years ago

Description

Added the new DMSP harmonic corrections for the IMAGE instruments to ocb_corrections.harmonic. Also improved the documentation to fix #110.

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)
This change requires a documentation update

How Has This Been Tested?

Added new unit tests and re-created harmonic offset figures from the publication.

Test Configuration:

Operating system: OS X Big Sur
Version number: python 3.9 and 3.8
Any details about your local setup that are relevant

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
[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.rst, summarising the changes
[x] Add yourself to AUTHORS.rst

coveralls commented 2 years ago

Coverage increased (+13.6%) to 94.05% when pulling 3111a7567f155923758a9f245b0c1960c07ba0cd on image_doc_update into ce1ee978f2f1f31e8777bed474750dcef493ee31 on develop.