Scale gradient and curl by sphere radius#1517
Open
rajeeja wants to merge 2 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates UXarray’s vector calculus API so gradient() and curl() return physically-scaled derivatives by default (using uxgrid.sphere_radius), while still allowing unit-sphere derivatives via scale_by_radius=False.
Changes:
- Add
scale_by_radiusparameter (defaultTrue) toUxDataArray.gradient()andUxDataArray.curl(). - Apply 1/radius scaling inside the shared
_compute_gradient()implementation. - Update and add tests to validate both unit-sphere and radius-scaled behavior.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
uxarray/core/gradient.py |
Adds optional scaling by uxgrid.sphere_radius to gradient computation. |
uxarray/core/dataarray.py |
Exposes scale_by_radius in public gradient()/curl() APIs and forwards it into _compute_gradient(). |
test/core/test_vector_calculus.py |
Updates existing gradient tests to use unit-sphere behavior and adds new scaling-by-radius assertions for gradient/curl. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
gradient()andcurl()byuxgrid.sphere_radiusby defaultscale_by_radius=Falsefor unit-sphere derivativesCloses #1516