Testing sources by rstoneback · Pull Request #53 · CosmicStudioSoftware/OMMBV

rstoneback · 2021-12-06T17:44:49Z

Description

Adds support for pure dipole and linear quadrupole sources to verify performance of OMMBV on multipole sources.

Addresses a variety of issues, including documented issues #50, #44.

Provides direct evidence that vectors are orthogonal for multipole fields.

Original Performance

There is an apparent reduction in performance for some linear quadrupoles in the equatorial plane. Current uncertainty on scaling values for drifts and electric fields is < 0.1%. In practical terms, given instrumentation errors are certainly higher, the observed uncertainty is fine for scientific applications. Still, looking to see if there is a way to improve this performance. Scaling uncertainty for dipole and linear quadrupole (along pole) is < .001%.

UPDATE

Performance improved and uncertainty with multipole fields is the same as dipole alone! Fixes are in here.
Also includes:

docstring improvements
code standard improvements
deprecation warning improvements
unit test overhaul
code reduction
bug fixes
Documentation runs on RTD again
Switch to setup.cfg
Switch to GitHub Actions for testing

Type of change

Please delete options that are not relevant.

Bug fix (non-breaking change which fixes an issue)
New test feature (non-breaking change which adds functionality)

How Has This Been Tested?

Running unit tests on known source magnetic fields.

Test Configuration:

MacOS
Python 3.8

Checklist:

rstoneback · 2021-12-09T16:04:38Z

I sorted out a bit of error and now the OMMBV vectors are even better. Uncertainty for multipole fields is at the same level as a pure dipole.

…ield line tracing.

…o longer have any meaning at a pole.

…her locations.

…ep size.

rstoneback · 2021-12-23T15:09:10Z

I'm giving up on windows testing. OMMBC appears to compile everything just fine. However, pytest tests the pure python code without the compiled and installed Fortran. I also dropped MacOS testing way back since there is no installed Fortran compiler on the machines. Runs locally on Mac.

jklenzing

Some structural suggestions on the workflows and cfg. Pulling out windows support is probably the right route for now. Included new minimum NEP29 versions as of Dec 26 2021.

jklenzing · 2021-12-23T15:04:14Z


 # Include extensions only when not on readthedocs.org
 if os.environ.get('READTHEDOCS', None) == 'True':
    extensions = []


Suggested change

extensions = []

from setuptools import setup

extensions = []

I've found the first setup needs to be at top level for setup.py develop to work.

jklenzing · 2021-12-23T15:04:23Z

-with open(os.path.join(here, version_filename)) as version_file:
-    version = version_file.read().strip()
+import os
+from setuptools import setup


Suggested change

from setuptools import setup

jklenzing · 2021-12-23T15:04:38Z

 else:
-    from numpy.distutils.core import setup, Extension
+    from numpy.distutils.core import Extension
+    from numpy.distutils.core import setup  # noqa: F811


Suggested change

from numpy.distutils.core import setup # noqa: F811

from numpy.distutils.core import setup

flake8 or whatever complains about a redefinition of setup if the noqa isn't there. If I don't have the original setup import though then python setup.py develop doesn't work.

jklenzing · 2021-12-23T15:07:07Z

+
+    - name: Run OMMBV setup.py
+      run: |
+        pip install -e ../OMMBV -t ../OMMBV


not windows compatible

I have yet to find a windows compatible command that really installs the package. It goes through the motions, compiles the Fortran, etc, however, I can't get pytest to use whatever is installed.

I think that it's skipping this part on windows. Github Actions will still try to load code locally if not installed.

Could probably set up os-dependent jobs here, one for unix, one for windows. But we'd need to test it on a windows machine locally, since I'm not sure if it's as easy as swapping directories. I'd bump this down the line since this is a big pull. Perhaps @JonathonMSmith can help?

I agree that I need help from someone with a local windows machine. From the Actions tab windows does run the pip install stuff and it runs without error. I used to have python setup.py develop which I'll probably go back to.

jklenzing · 2021-12-23T15:07:49Z

+long_description = file: README.md, CHANGELOG.md
+long_description_content_type = text/markdown
+classifiers =
+    Development Status :: 5 - Production/Stable


is pre-1.0 production?

I am prepping 1.0 here.

jklenzing · 2021-12-23T15:09:07Z

+    Programming Language :: Python :: 3.7
+    Programming Language :: Python :: 3.8
+    Programming Language :: Python :: 3.9
+    Operating System :: MacOS :: MacOS X
+    Operating System :: POSIX :: Linux


Update based on which tests are run

I originally left Mac on there since I'm running local tests. I can update if the standard is to report what is publicly run.

Co-authored-by: Jeff Klenzing <jklenzing@gmail.com>

…ex_location_info`

…into testing_sources

rstoneback added 11 commits December 6, 2021 11:38

TST: Add support for test fields

d93b0f2

STY: General cleanup. Bug fix for integer valued starting point.

dc00c45

STY: Test cleanup

5aed906

ENH: Improved uncertainty for multipole fields

72e8768

STY: Restored IGRF as default mag field

cfb10b4

STY: Altered plot titles

b5bf191

STY: Docstring improvements

932fd99

STY: Removed commented code that yields less accurate calculations

85ccb41

STY: Cleanup. More graceful response to areas with uncertain vectors.

bed0dec

STY: General style cleanup

7af7f12

STY: Removed commented algorithm variation.

1c59ea5

rstoneback added 18 commits December 9, 2021 10:08

STY: Removed unused function.

83780bf

ENH: Improve robustness nan inputs

66ebcbf

STY: Improve comments

43f1479

STY: Moved test

600e10e

STY: Moved test

07d7f65

STY: Minor cleanup.

f282ead

ENH: Improved performance at high latitudes. Improved robustness of f…

8143d22

…ield line tracing.

STY: Deprecate scalar

6264ea5

STY: Deprecate scalar

98e50b0

STY: Improved deprecation warnings. Deprecated edge_steps

289c0b1

ENH: Added protection for calculations at magnetic pole. East/North n…

447acce

…o longer have any meaning at a pole.

STY: Update changelog

069c402

STY: Update docstring

165b58c

BUG: Removed version file that was causing issues.

d70086a

TST: Correct imports

3275715

TST: Added test for pole location.

7e6f60d

ENH: Added pole_tol. Improved code at pole. Deprecated scalar in ot…

055e453

…her locations.

ENH: Made field stepping and termination more robust for any given st…

283aad9

…ep size.

rstoneback added 13 commits December 22, 2021 20:21

STY: Tweak pytest command

8cd48e2

STY: Tweak pytest command

0133324

STY: Tweak pytest command

072e88a

STY: Tweak pytest command

8b2765d

STY: Tweak pytest command

5bab2ac

STY: Tweak pytest command

f5cff38

STY: Tweak pytest command

95b28af

STY: Tweak pytest command

1fb5944

STY: Tweak pytest command

ea8e368

STY: Tweak pytest command

eb79760

STY: Tweak pytest command

be592a3

STY: Tweak pytest command

3ad8d0a

STY: Tweak pytest command

568c3b6

TST: Removed windows testing support from GitHub Workflows.

3b65ec8

jklenzing reviewed Dec 23, 2021

View reviewed changes

rstoneback commented Dec 23, 2021

View reviewed changes

Comment thread CHANGELOG.md Outdated

rstoneback and others added 11 commits December 23, 2021 09:40

Apply suggestions from code review

b747da0

Co-authored-by: Jeff Klenzing <jklenzing@gmail.com>

Update setup.cfg

643f530

Co-authored-by: Jeff Klenzing <jklenzing@gmail.com>

ENH: Added min_loops and enabled general pass-thru of kwargs to `ap…

97a37c7

…ex_location_info`

ENH: Added max_steps to apex_location_info and test.

4d7e082

TST: Added test that uses apex_kwargs

020b125

BUG/TST: Added missing parametrize label.

28bb8d5

Merge branch 'testing_sources' of https://github.com/rstoneback/OMMBV …

b165408

…into testing_sources

STY: Update testing versions

de38a90

STY: Update changelog

274e4a4

TST: Restored python setup.py develop

9dc204a

STY: Updated email address

e3d39cc

rstoneback merged commit 03b9d7f into develop Dec 24, 2021

rstoneback deleted the testing_sources branch December 24, 2021 01:59

	from numpy.distutils.core import setup # noqa: F811
	from numpy.distutils.core import setup

Conversation

rstoneback commented Dec 6, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of change

How Has This Been Tested?

Checklist:

Uh oh!

rstoneback commented Dec 9, 2021

Uh oh!

rstoneback commented Dec 23, 2021

Uh oh!

jklenzing left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

rstoneback commented Dec 6, 2021 •

edited

Loading

jklenzing left a comment •

edited

Loading