Consider adding opt-in support for circular axes when calling `bounds_to_vertices` (related to #594)

Aperta
#596 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
38/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
python
Ambito
data

Direzione di ricerca

Start by reading the bounds_to_vertices implementation and the context in issues #594 and #595. Define the expected behavior for circular_period and start, including seam rotation and periodic axes beyond longitude. Done means an opt-in API handles mixed circular coordinates without NotImplementedError while preserving existing ascending and descending behavior.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Description

The latest bounds_to_vertices() function in cf-xarray v0.10.7+ only handles core dimensions that are in ascending or descending order. Core dims that are in mixed order instead raise a NotImplementedError #595 with a message for the user to normalize coordinates to a monotonic convention (related comment).

Examples

  • Ascending

    [0, 1, 2, ..., 357, 358, 359]

  • Descending

    [359, 358, 357, ..., 2, 1, 0]

  • Mixed (wraps at seam)

    [0, 1, 2, ..., 179, -180, -179, ..., -1]

bounds_to_vertices() works in the first two cases but fails in the third.

Proposed solution

For a long-term solution, it might be worth considering opt-in support for circular axes, e.g.:

bounds_to_vertices(..., circular_period=360.0, start=None)

With circular_period set, cf-xarray could:

  • Detect circular monotonicity
  • Rotate away from the seam
  • Proceed safely as if the dimension were monotonic

While longitude (circular_period=360.0) is the most common use case, the same approach could generalize to other periodic axes (e.g. angles, phases).

Why it is useful

  • Users working with model output that mixes 0–360 and −180–180 conventions may encounter NotImplementedError today and must manually normalize coordinates before downstream operations.
  • This affects packages such as xESMF, which rely on bounds_to_vertices() but do not implement detection/normalization for circular axes.
  • I’ve opened a related xESMF issue for visibility: https://github.com/pangeo-data/xESMF/issues/454
Lingua principale
Python
Stelle
181
Fork
49
Merge medio
43m
PR unite (30g)
1

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di xarray-contrib/cf-xarray

Tutte le issue di xarray-contrib/cf-xarray

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.