Add support for unitful #70
Merged
Conversation
This file contains 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
Sbozzolo
force-pushed
the
gb/unitufl
branch
2 times, most recently
from
354fda3
to
e9f582e
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #70 +/- ##
==========================================
+ Coverage 96.31% 96.35% +0.03%
==========================================
Files 8 9 +1
Lines 516 548 +32
==========================================
+ Hits 497 528 +31
- Misses 19 20 +1 ☔ View full report in Codecov by Sentry. |
Sbozzolo
force-pushed
the
gb/unitufl
branch
2 times, most recently
from
d69aed4
to
3a36abf
Compare
This commit adds support for physical units managed by Unitful.jl. Unitful is added as an extension. Currently, ClimaAnalysis.jl always includes this extension (and Unitful is a hard dependency of ClimaAnalysis), but this opens a pathway to making Unitful an optional dependency in the future if we decide to do so. (I am taking this idea from Unitful itself.) The technical choice on how to integrate Unitful is the following: In the constructor, ClimaAnalysis scans for the `units` keyword in the attributes. When found, we try to parse it with `Unitful.uparse`. If possible, we replace the value for `units` in `attributes` with the `Unitful` version. If it is not possible, we leave the string. When units are requested with `ClimaAnalysis.units`, we always return a string. The choice being made here is that we modify the input given (from `String` to `Unitful`), instead of creating a separate box where to put this information. The reason for this choice is that it removes the need to keep information synced and provide a single ground truth of what units are. We also decide to not attach units directly to `data` to avoid performance penalties with manipulating large arrays.
Extensions could have name collisions, adding ClimaAnalysis in front dramatically reduces the likelihood and follows conventions.
Sbozzolo
added a commit
to CliMA/ClimaAtmos.jl
that referenced
this pull request
Aug 29, 2024
CliMA/ClimaAnalysis.jl#70 is _slightly_ breaking if units are accessed directly
Sbozzolo
added a commit
to CliMA/ClimaAtmos.jl
that referenced
this pull request
Aug 29, 2024
CliMA/ClimaAnalysis.jl#70 is _slightly_ breaking if units are accessed directly
Sbozzolo
added a commit
to CliMA/ClimaAtmos.jl
that referenced
this pull request
Aug 29, 2024
CliMA/ClimaAnalysis.jl#70 is _slightly_ breaking if units are accessed directly
Sbozzolo
added a commit
to CliMA/ClimaAtmos.jl
that referenced
this pull request
Aug 29, 2024
CliMA/ClimaAnalysis.jl#70 is _slightly_ breaking if units are accessed directly
Sbozzolo
added a commit
to CliMA/ClimaAtmos.jl
that referenced
this pull request
Aug 29, 2024
CliMA/ClimaAnalysis.jl#70 is _slightly_ breaking if units are accessed directly
AlexisRenchon
approved these changes
Aug 29, 2024
There was a problem hiding this comment.
This a beautiful PR!
I have one question (curiosity) but no request
Why did you define convert_units docstring in Var.jl, and the actual function in ext/ClimaAnalysisUnitfulExt.jl?
Is it to keep ClimaAnalysisUnitfulExt focused on actual code, for better readability?
I had it there originally, but Documenter wouldn't find the docstring. |
oalcabes
pushed a commit
to CliMA/ClimaAtmos.jl
that referenced
this pull request
Aug 30, 2024
CliMA/ClimaAnalysis.jl#70 is _slightly_ breaking if units are accessed directly
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.
This commit adds support for physical units managed by Unitful.jl.
Unitful is added as an extension. Currently, ClimaAnalysis.jl always includes this extension (and Unitful is a hard dependency of
ClimaAnalysis), but this opens a pathway to making Unitful an optional dependency in the future if we decide to do so. (I am taking this idea from Unitful itself.)
The technical choice on how to integrate Unitful is the following:
In the constructor, ClimaAnalysis scans for the
unitskeyword in the attributes. When found, we try to parse it withUnitful.uparse. If possible, we replace the value forunitsinattributeswith theUnitfulversion. If it is not possible, we leave the string.When units are requested with
ClimaAnalysis.units, we always return a string.The choice being made here is that we modify the input given (from
StringtoUnitful), instead of creating a separate box where to put this information. The reason for this choice is that it removes the need to keep information synced and provide a single ground truth of what units are.We also decide to not attach units directly to
datato avoid performance penalties with manipulating large arrays.This PR also cleans up a couple of things about extensions along the way.
Closes #53 (except for dimensions)