xgcm

A Python package for analyzing general circulation model output data.
https://github.com/xgcm/xgcm

Category: Climate Change
Sub Category: Climate Data Processing and Analysis

Keywords

climate-model finite-volume gridded-data python

Keywords from Contributors

oceanography climate-science ocean-modelling pangeo climate compressed exoplanets zarr geoscience earth-science

Last synced: about 23 hours ago
JSON representation

Repository metadata

python package for analyzing general circulation model output data

• Host: GitHub
• URL: https://github.com/xgcm/xgcm
• Owner: xgcm
• License: mit
• Created: 2015-08-29T04:57:31.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2025-04-14T19:52:45.000Z (13 days ago)
• Last Synced: 2025-04-18T21:19:45.583Z (9 days ago)
• Topics: climate-model, finite-volume, gridded-data, python
• Language: Python
• Homepage: http://xgcm.readthedocs.org
• Size: 58.7 MB
• Stars: 237
• Watchers: 24
• Forks: 82
• Open Issues: 117
• Releases: 20
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Citation: CITATION.cff

README.rst

          xgcm: General Circulation Model Postprocessing with xarray
==========================================================

|pypi| |conda forge| |conda-forge| |Build Status| |codecov| |docs| |DOI| |license| |Code style| |pre-commit|

Binder Examples
---------------

========= ============== ============================================================================
Link      Provider       Description
========= ============== ============================================================================
|Binder|  mybinder.org   Basic self-contained example
|PBinder| Pangeo Binder  More complex examples integrated with other Pangeo tools (dask, zarr, etc.)
========= ============== ============================================================================

Description
-----------

**xgcm** is a python package for working with the datasets produced by numerical
`General Circulation Models `_
(GCMs) and similar gridded datasets that are amenable to
`finite volume `_ analysis.
In these datasets, different variables are located at different positions with
respect to a volume or area element (e.g. cell center, cell face, etc.)
xgcm solves the problem of how to interpolate and difference these variables
from one position to another.

xgcm consumes and produces xarray_ data structures, which are coordinate and
metadata-rich representations of multidimensional array data. xarray is ideal
for analyzing GCM data in many ways, providing convenient indexing and grouping,
coordinate-aware data transformations, and (via dask_) parallel,
out-of-core array computation. On top of this, xgcm adds an understanding of
the finite volume `Arakawa Grids`_ commonly used in ocean and atmospheric
models and differential and integral operators suited to these grids.

xgcm was motivated by the rapid growth in the numerical resolution of
ocean, atmosphere, and climate models. While highly parallel supercomputers can
now easily generate tera- and petascale datasets, common post-processing
workflows struggle with these volumes. Furthermore, we believe that a flexible,
evolving, open-source, python-based framework for GCM analysis will enhance
the productivity of the field as a whole, accelerating the rate of discovery in
climate science. xgcm is part of the Pangeo_ initiative.

Getting Started
---------------

To learn how to install and use xgcm for your dataset, visit the `xgcm documentation`_.


.. _Pangeo: http://pangeo.io
.. _dask: http://dask.pydata.org
.. _xarray: http://xarray.pydata.org
.. _Arakawa Grids: https://en.wikipedia.org/wiki/Arakawa_grids
.. _xgcm documentation: https://xgcm.readthedocs.io/

.. |conda forge| image:: https://img.shields.io/conda/vn/conda-forge/xgcm
   :target: https://anaconda.org/conda-forge/xgcm
.. |DOI| image:: https://zenodo.org/badge/41581350.svg
   :target: https://zenodo.org/badge/latestdoi/41581350
.. |Build Status| image:: https://img.shields.io/github/workflow/status/xgcm/xgcm/CI?logo=github
   :target: https://github.com/xgcm/xgcm/actions
   :alt: GitHub Workflow CI Status
.. |codecov| image:: https://codecov.io/github/xgcm/xgcm/coverage.svg?branch=master
   :target: https://codecov.io/github/xgcm/xgcm?branch=master
   :alt: code coverage
.. |pypi| image:: https://badge.fury.io/py/xgcm.svg
   :target: https://badge.fury.io/py/xgcm
   :alt: pypi package
.. |docs| image:: http://readthedocs.org/projects/xgcm/badge/?version=latest
   :target: http://xgcm.readthedocs.org/en/stable/?badge=latest
   :alt: documentation status
.. |license| image:: https://img.shields.io/github/license/mashape/apistatus.svg
   :target: https://github.com/xgcm/xgcm
   :alt: license
.. |Code style| image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :target: https://github.com/python/black
   :alt: Code style
.. |Binder| image:: https://mybinder.org/badge_logo.svg
   :target: https://mybinder.org/v2/gh/xgcm/xgcm/master?filepath=doc%2Fexample_mitgcm.ipynb
.. |PBinder| image:: https://binder.pangeo.io/badge_logo.svg
   :target: https://binder.pangeo.io/v2/gh/pangeo-data/pangeo-ocean-examples/master
.. |conda-forge| image:: https://img.shields.io/conda/dn/conda-forge/xgcm?label=conda-forge
   :target: https://anaconda.org/conda-forge/xgcm
.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/xgcm/xgcm/master.svg
   :target: https://results.pre-commit.ci/latest/github/xgcm/xgcm/master
   :alt: pre-commit.ci status

        

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Abernathey"
  given-names: "Ryan P."
  orcid: "https://orcid.org/0000-0001-5999-4917"
- family-names: "Busecke"
  given-names: "Julius J. M."
  orcid: "https://orcid.org/0000-0001-8571-865X"
- family-names: "Smith"
  given-names: "Timothy Andrew"
  orcid: "https://orcid.org/0000-0003-4463-6126"
- family-names: "Deauna"
  given-names: "Josephine Dianne"
  orcid: "https://orcid.org/0000-0002-0733-9440"
- family-names: "Banihirwe"
  given-names: "Anderson"
  orcid: "https://orcid.org/0000-0001-6583-571X"
- family-names: "Nicholas"
  given-names: "Thomas"
  orcid: "https://orcid.org/0000-0002-2176-0530"
- family-names: "Fernandes"
  given-names: "Filipe"
  orcid: "https://orcid.org/0000-0003-4165-2913"
- family-names: "James"
  given-names: "Bourbeau"
  orcid: "https://orcid.org/0000-0003-2164-7789"
- family-names: "Dussin"
  given-names: "Raphael"
  orcid: "https://orcid.org/0000-0003-4004-4553"
- family-names: "Cherian"
  given-names: "Deepak A."
  orcid: "https://orcid.org/0000-0002-6861-8734"
- family-names: "Caneill"
  given-names: "Romain"
  orcid: "https://orcid.org/0000-0001-6649-4275"
- family-names: "Sinha"
  given-names: "Anirban"
  orcid: "https://orcid.org/0000-0002-7122-3549"
- family-names: "Uieda"
  given-names: "Leonardo"
  orcid: "https://orcid.org/0000-0001-6123-9515"
- family-names: "Rath"
  given-names: "Willi"
  orcid: "https://orcid.org/0000-0003-1951-8494"
- family-names: "Balwada"
  given-names: "Dhruv"
  orcid: "https://orcid.org/0000-0001-6632-0187"
- family-names: "Constantinou"
  given-names: "Navid C."
  orcid: "https://orcid.org/0000-0002-8149-4094"
- family-names: "Ponte"
  given-names: "Aurélien"
  orcid: "https://orcid.org/0000-0002-0252-6028"
- family-names: "Zhou"
  given-names: "Yuxin"
  orcid: "https://orcid.org/0000-0002-3523-8524"
- family-names: "Uchida"
  given-names: "Takaya"
  orcid: "https://orcid.org/0000-0002-8654-6009"
- family-names: "Thielen"
  given-names: "Jon"
  orcid: "https://orcid.org/0000-0002-5479-0189"
title: "xgcm"
url: "https://github.com/xgcm/xgcm"
# version and doi are completed by Zenodo automatically, do not provide here.

---

Owner metadata

• Name: xgcm
• Login: xgcm
• Email:
• Kind: organization
• Description: xarray-based tools for general circulation model analysis
• Website:
• Location:
• Twitter: xgcm_dev
• Company:
• Icon url: https://avatars.githubusercontent.com/u/14025832?v=4
• Repositories: 8
• Last ynced at: 2024-04-16T02:52:50.285Z
• Profile URL: https://github.com/xgcm

---

GitHub Events

Total

• Create event: 9
• Issues event: 15
• Watch event: 14
• Delete event: 7
• Member event: 3
• Issue comment event: 69
• Push event: 47
• Pull request review comment event: 3
• Pull request review event: 8
• Pull request event: 33
• Fork event: 1

Last Year

• Create event: 9
• Issues event: 15
• Watch event: 14
• Delete event: 7
• Member event: 3
• Issue comment event: 69
• Push event: 47
• Pull request review comment event: 3
• Pull request review event: 8
• Pull request event: 33
• Fork event: 1

---

Committers metadata

Last synced: 6 days ago

Name	Email	Commits
Julius Busecke	j****s@l****u	159
Ryan Abernathey	r****y@g****m	140
Timothy Smith	t****4@u****u	30
dependabot[bot]	4****]	27
pre-commit-ci[bot]	6****]	22
jdldeauna	6****a	20
Anderson Banihirwe	a****e@u****u	18
Julius Busecke	j****e@p****u	18
Tom Nicholas	3****s	15
Nora Loose	n****e@g****m	14
Dominic Orchard	d****d@g****m	9
Julius Busecke	j****0@c****u	5
stickler-ci	s****t@s****m	5
Filipe Fernandes	o****f@g****m	4
Henri Drake	h****e@u****u	3
James Bourbeau	j****u@g****m	3
Romain Caneill	r****l@y****r	3
Ben Orchard	t****n@g****m	2
Deepak Cherian	d****n	2
Navid C. Constantinou	n****y	2
jthielen	j****n@t****e	2
Raphael Dussin	r****n@g****m	2
Ci Zhang	z****i@y****m	2
jatkinson1000	1****0	1
Yuxin	x****o@g****m	1
Christopher L.P. Wolfe	c****e@s****u	1
hfdrake	h****e@p****l	1
Willi Rath	w****h	1
Takaya Uchida	t****a@l****u	1
Riley Brady	r****y@c****u	1
and 6 more...

Committer domains:

• columbia.edu: 2
• ldeo.columbia.edu: 2
• bopen.eu: 1
• berkeley.edu: 1
• colorado.edu: 1
• stonybrook.edu: 1
• thielen.science: 1
• uci.edu: 1
• stickler-ci.com: 1
• princeton.edu: 1
• ualr.edu: 1
• utexas.edu: 1

---

Issue and Pull Request metadata

Last synced: 2 days ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/xgcm/xgcm

---

---

---

Package metadata

• Total packages: 2
• Total downloads:
  • pypi: 5,517 last-month
• Total docker downloads: 272
• Total dependent packages: 16 (may contain duplicates)
• Total dependent repositories: 78 (may contain duplicates)
• Total versions: 30
• Total maintainers: 2

---

Dependencies

Score: 18.133657334534455