FYI about xGCM package status, which can affect xCDAT

[tomvothecoder]

FYI @xCDAT/core-developers

Source: https://discourse.pangeo.io/t/status-of-xgcm/4986

Background and Current Status

• Stability and Maturity:
  The discussion begins by noting that the last “official” release of xGCM (v0.8.1) dates from 2022 and now produces numerous deprecation warnings. However, several responses emphasize that the code has reached a point of stability and maturity—it remains fully usable for its main purpose (handling staggered grids) even if it isn’t evolving rapidly.

• Lack of Active Maintenance:
  Multiple contributors point out that while xGCM continues to function effectively, there is currently no dedicated team of maintainers actively driving its development. The original core team—including rabernat, jbusecke, and dcherian—no longer has the bandwidth to devote time to the project due to changes in their professional commitments, leaving the burden of updating deprecated parts to the community.

Technical Debt and Feature Potential

• Deprecation Cycle:
  One contributor explains that a significant refactor was previously implemented to optimize performance with dask, which subsequently triggered a deprecation cycle that remains unfinished. The resulting deprecation warnings stem partly from this incomplete cycle and partly from updates to xarray’s API over recent years.

• Scope for Expansion:
  Although the current feature set is robust for its intended functionality (such as handling staggered grids), there is potential to broaden the package's scope. For instance, new features might eventually support various grid topologies and numerical methods—a direction that was explored but never fully realized.

Community and Future Directions

• Call for New Maintainers:
  The discussion repeatedly calls for willing volunteers or a dedicated group to assume the role of maintaining xGCM. Established and new community members alike are encouraged to step forward. One participant even expresses readiness for his research group to take on long-term responsibilities, particularly for physical oceanography applications.

• Operational Considerations:
  There is also discussion regarding the integration of xGCM with external resources, such as the Pangeo example gallery (located in a separate repository called xgcm-examples). While the gallery has been a valuable resource, some maintainers suggest that it might be time to decouple it from the core documentation due to its reliance on older, unmaintained infrastructure.

• Archiving Warning:
  As a final measure, if no one steps up to maintain the project, there is a possibility that xGCM might eventually be archived to avoid creating false expectations about ongoing support.

Summary of Contributors’ Comments

• rabernat:
  He emphasizes that xGCM is mature and stable but highlights the urgent need for someone to assume maintenance responsibilities.

• TomNicholas:
  He provides a detailed explanation of the package’s evolution, outlining its technical debt (especially the incomplete deprecation cycle following a major refactor) and stresses the importance of finding new maintainers.

• jbusecke:
  He echoes the necessity for consistent maintenance and indicates a willingness to offer guidance if a dedicated individual or group steps up to take on the project.

• hdrake:
  Later in the discussion, hdrake discusses plans within his own group to become actively involved in sustaining xGCM, particularly focusing on its relevance to physical oceanography.

Overall, while xGCM remains a stable and useful tool within the geospatial and oceanographic communities, its future development and upkeep depend on enhanced community engagement and a long-term maintenance commitment.

-- OpenAI. (2025, April 09). Response to a query about the status and development of xGCM [ChatGPT conversation]. Retrieved from https://chat.openai.com/