Add Var.split_by_season #79
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #79 +/- ##
==========================================
+ Coverage 96.37% 96.55% +0.18%
==========================================
Files 10 10
Lines 607 639 +32
==========================================
+ Hits 585 617 +32
Misses 22 22 ☔ View full report in Codecov by Sentry. |
Sbozzolo
approved these changes
Sep 9, 2024
NEWS.md
Outdated
| ### Split by season | ||
| `OutputVar`s can be split by seasons using `split_by_season(var)` provided that a start date | ||
| can be found in `var.attributes["start_date"]` and time is a dimension in the `OutputVar`. | ||
| The unit of time is expected to be seconds. The function `split_by_season(var)` return a |
There was a problem hiding this comment.
Suggested change
| The unit of time is expected to be seconds. The function `split_by_season(var)` return a | |
| The unit of time is expected to be seconds. The function `split_by_season(var)` returns a |
docs/src/var.md
Outdated
| ## Split by season | ||
| `OutputVar`s can be split by seasons using `split_by_season(var)` provided that a start date | ||
| can be found in `var.attributes["start_date"]` and time is a dimension in the `OutputVar`. | ||
| The unit of time is expected to be seconds. The function `split_by_season(var)` return a |
There was a problem hiding this comment.
Suggested change
| The unit of time is expected to be seconds. The function `split_by_season(var)` return a | |
| The unit of time is expected to be seconds. The function `split_by_season(var)` returns a |
src/Var.jl
Outdated
| error("Start date is not found in var") | ||
|
|
||
| season_dates = | ||
| split_by_season(time_to_date.(start_date, var.dims[time_name(var)])) |
There was a problem hiding this comment.
Suggested change
| split_by_season(time_to_date.(start_date, var.dims[time_name(var)])) | |
| split_by_season(time_to_date.(start_date, times(var))) |
src/Var.jl
Outdated
| season_data = ( | ||
| _data_at_dim_vals( | ||
| var.data, | ||
| var.dims[time_name(var)], |
There was a problem hiding this comment.
Suggested change
| var.dims[time_name(var)], | |
| times(var), |
ph-kev
force-pushed
the
kp/split-by-season-outputvar
branch
from
9b3c473
to
313225b
Compare
Sbozzolo
reviewed
Sep 10, 2024
Sbozzolo
reviewed
Sep 10, 2024
Sbozzolo
reviewed
Sep 10, 2024
Sbozzolo
reviewed
Sep 10, 2024
Sbozzolo
reviewed
Sep 10, 2024
Sbozzolo
reviewed
Sep 10, 2024
Sbozzolo
reviewed
Sep 10, 2024
Also, add Utils.period_to_seconds_float. These functions are functionally identical to the equivalent functions in ClimaUtilities. We do not export from ClimaUtilities because we do not want to add ClimaUtilities as a dependency.
We do this because we want to show the documentation for Var.split_by_season and not Utils.split_by_season.
Bug introduced: The documentation show the wrong module name for Var.split_by_season. It is ClimaAnalysis.Utils.split_by_season instead of ClimaAnalysis.Var.split_by_season.
ph-kev
force-pushed
the
kp/split-by-season-outputvar
branch
from
313225b
to
c9c0eec
Compare
Sbozzolo
approved these changes
Sep 10, 2024
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.
Close #78 - This PR implement split_by_season for
OutputVars. It return four OutputVars with each one corresponding to a season. This PR also add functions for converting from date to time and time to date (Utils.time_to_date, Utils.date_to_time, Utils.period_to_seconds_float).This PR add a bug to the documentation which cause the documentation for
Var.split_by_seasonto beClimaAnalysis.Utils.split_by_seasoninstead ofClimaAnalysis.Var.split_by_season.