Version 0.5 Release - Githubissues

CosmicStudioSoftware / OMMBV

Orthogonal Multipole Magnetic Basis Vectors - Complete orthogonal vector basis with accurate field-line mapping of electric fields and ion drifts within multipole magnetic fields

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

10 stars 7 forks source link

Version 0.5 Release #37

Closed rstoneback closed 4 years ago

rstoneback commented 4 years ago

Implemented a new algorithm that produces first orthogonal geomagnetic basis vector system that works for non-Spherical planets as well as for multi-pole magnetic fields.

rstoneback commented 4 years ago

I'm planning on releasing this version next week. Pinging @aburrell and @jklenzing as an FYI. I'm certainly open to code review though given the size of the pull it is not expected.

rstoneback commented 4 years ago

That should cover most everything:

Answered the questions
Added docstrings to test code
Made numerous formatting improvements
Moved Notes to after Return in docstrings
Added new method with a single output dict for the geomagnetic basis vectors. Existing method kept for compatibility of downstream code.
One request not currently filled. The unit tests are still making plots. The figures are a big part of testing for this package. It is also true that when I run testing locally I set it to high resolution and use the plots in the developing manuscript.

rstoneback commented 4 years ago

Thanks for the review @aburrell and @jklenzing . Let's talk about the plots tomorrow. Cheers.

rstoneback commented 4 years ago

I added issue #38 to improve the unit tests by removing the plots. I also modified manifest.in to exclude the test directory for pip produced distributions. Standard users won't see the unit tests. I plan on moving forward with the release. Thanks again for the feedback.