sgrid helper utilities

Open
#204 15 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
15/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
data

Research direction

No target files or tests are named. Start by reviewing the sgrid documentation and the gridded.pysgrid reference linked in the issue, then clarify the intended metadata and helper API with the stakeholders. Done currently means an agreed scope and implementation plan for a possible sgrid module.

Written by the indexing model from the issue text.

Description

opinion wanted

Copied from #201 re: https://sgrid.github.io/sgrid/

I think there's an opportunity for better metadata handling around gridded, xgcm, sgrid, xesmf with cf_xarray providing a little helper function layer to consolidate the code.

It seems a common issue is figuring out cell metrics; and cell centers and corner points. This is needed by xgcm, maybe cmip6_preprocessing, and probably xesmf (definitely needed to specify xesmf inputs).

I think cf_xarray can provide a tiny sgrid module that helps autoguess some sgrid parameters and maybe parses the sgrid attributes and lets them be used in a convenient way. We can take inspiration from (and maybe copy over) https://noaa-orr-erd.github.io/gridded/gridded.pysgrid.html

I think a call some time in the next two weeks would be good to sort this out, and make a plan.

cc @aulemahal @mgrover1 @malmans2

Dominant language
Python
Stars
181
Forks
49
Avg merge
43m
Merged PRs (30d)
1

Contributor guide

No contributing guide indexed for this repository

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.

More from xarray-contrib/cf-xarray

All issues in xarray-contrib/cf-xarray

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.