xarray-contrib / xarray-contrib/xwrf

[MISC]: Ensure we are fully compatible with expectations of xgcm usage

Open
#192 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
70
Forks
18
Avg merge
21m
Merged PRs (30d)
1

Description

What is your issue?

94612a34804dd35236c3f3922dbf3165d83f9377 identified a DeprecationWarning from xgcm. While it may or may not be an issue in practice, it would be nice to have a set of tests with xgcm that raise no errors or warnings with its current versions (so as to avoid any possible issues down the road). While doing this, it might also be worth verifying the current state of xwrf's approach to staggered coordinates still lines up with how xgcm does things in the more general sense (I unfortunately have not kept up myself with recent xgcm development).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing commit 94612a34804dd35236c3f3922dbf3165d83f9377 and the existing xwrf handling of staggered coordinates, then compare it with current xgcm behavior. Add compatibility tests that produce no errors or warnings with current xgcm versions; done means the tests pass and the staggered-coordinate approach remains aligned with xgcm.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data, testing
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.