Skip to content

Initial prototype to refactor custom_seasons API with Xarray SeasonGrouper() API [WIP] #715

Draft
tomvothecoder wants to merge 17 commits intomainfrom
feature/714-season-grouper
Draft

Initial prototype to refactor custom_seasons API with Xarray SeasonGrouper() API [WIP] #715
tomvothecoder wants to merge 17 commits intomainfrom
feature/714-season-grouper

Conversation

@tomvothecoder
Copy link
Copy Markdown
Collaborator

@tomvothecoder tomvothecoder commented Nov 14, 2024 •
edited
Loading

Description

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • My changes generate no new warnings
  • Any dependent changes have been merged and published in downstream modules

If applicable:

  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass with my changes (locally and CI/CD build)
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have noted that this is a breaking change for a major release (fix or feature that would cause existing functionality to not work as expected)

@tomvothecoder
Add baseline unit tests
7716efc 
- Remove logic for requiring all 12 months to be used
@tomvothecoder
Add support for shifting months in seasons spanning calendar year
ade02ba
@tomvothecoder
Add explaination of code for spanning months
2a87cf0
@tomvothecoder
Replace drop_incomplete_djf with drop_incomplete_seasons
6b4ec65
@tomvothecoder
Fix _drop_incomplete_seasons() adding dims to variables
fbad335 
- Add conditional that determines whether subsetting time coordinates is necessary with custom seasons
- Update docstrings for `season_config`
- Add tests
@tomvothecoder
Add deprecation warning for "drop_incomplete_djf"
4a896ba
@tomvothecoder
Fix tests
9f496e5
@tomvothecoder
Add test to cover missing line in _drop_incomplete_season
7cb6910
@tomvothecoder
Add clear error message when no complete seasons are found
1cf4364
@tomvothecoder
Update deprecation version for drop_incomplete_djf
a050884
@tomvothecoder
Update static time dim ref to CF interpreted dim key
5ace7a8
@tomvothecoder
Add drop_incomplete_djf back
25e31f7
@tomvothecoder
Move deprecation warning to inside DJF conditional
2b47972
@tomvothecoder
Update comment about .where concatenating time din
05496ed
@tomvothecoder
Refactor logic for shifting months to use Xarray instead of Pandas
0b6852f 
- Months are also shifted in the `_preprocess_dataset()` method now. Before months were being shifted twice, once when dropping incomplete seasons or DJF, and a second time when labeling time coordinates.
@tomvothecoder
Add todo comments
8d156c2
@tomvothecoder
Initial prototype using Xarray SeasonGrouper`
2e736ca
@github-actions github-actions Bot added the type: enhancement New enhancement request label Nov 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

type: enhancement New enhancement request

Projects

xCDAT Development
Status: In Progress

Milestone

FY25Q4 (07/01/25 - 09/30/25)

Development

Successfully merging this pull request may close these issues.

[Enhancement]: Refactor custom_seasons to use Xarray's SeasonGrouper() API [WIP]

1 participant

@tomvothecoder