Add control over spherical harmonics expansion degree #21
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
This pull request introduces enhancements to three functions
igrf
,igrf_gc
, andigrf_V
within the repository. These changes provide users with greater control over the spherical harmonics expansion by allowing them to specify the minimum and maximum degree of the expansion.Key Changes
New Arguments:
min_degree
andmax_degree
) to the modified functions.min_degree=1
andmax_degree=1
.Improved Flexibility:
Users can now isolate specific contributions to the global magnetic field of the Earth.
Backward Compatibility:
Default values ensure that the original behavior of the functions is preserved when the new arguments are not provided.
Testing Instructions
Pull this branch and install the updated package.
Test the modified functions with various
min_degree
andmax_degree
combinations:min_degree=1, max_degree=1
(pure dipole field).min_degree=2, max_degree=13
(multi-pole contributions).Verify that results match expectations for the original behavior when no new arguments are provided.
Please provide feedback or suggest further refinements if needed.