Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add xgcm module #5

Closed
wants to merge 1 commit into from
Closed

Add xgcm module #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions xwrf/xgcm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import xgcm


def to_xgcm(ds):
"""
Helper function to convert an xwrf dataset to an XGCM grid object
"""
_required_coords = ['XLAT_M', 'XLAT_C', 'XLONG_M', 'XLONG_C']

if not set(_required_coords).issubset(list(ds.coords)):
raise ValueError(f'Missing Required Coordinates: {_required_coords}')

grid = xgcm.Grid(
ds,
coords={
'X': {'inner': 'XLAT_M', 'outer': 'XLAT_C'},
'Y': {'inner': 'XLONG_M', 'outer': 'XLONG_C'},
},
)
return grid