xgcm

python package for analyzing general circulation model output data

https://github.com/xgcm/xgcm

Science Score: 64.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
✓
Academic publication links
Links to: zenodo.org
✓
Committers with academic emails
11 of 36 committers (30.6%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (15.0%) to scientific vocabulary

Keywords

climate-model finite-volume gridded-data python

Keywords from Contributors

climate climate-analysis pangeo geoscience climate-science oceanography cf-conventions mesh particles xgcm

Last synced: 6 months ago · JSON representation ·

Repository

python package for analyzing general circulation model output data

Basic Info

Host: GitHub
Owner: xgcm
License: mit
Language: Python
Default Branch: master
Homepage: http://xgcm.readthedocs.org
Size: 58.7 MB

Statistics

Stars: 241
Watchers: 24
Forks: 82
Open Issues: 113
Releases: 21

Topics

climate-model finite-volume gridded-data python

Created over 10 years ago · Last pushed 6 months ago

Metadata Files

Readme License Code of conduct Citation

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

Owner

Name: xgcm
Login: xgcm
Kind: organization

Twitter: xgcm_dev
Repositories: 8
Profile: https://github.com/xgcm

xarray-based tools for general circulation model analysis

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.

GitHub Events

Total

Create event: 11
Release event: 1
Issues event: 21
Watch event: 18
Delete event: 7
Member event: 3
Issue comment event: 83
Push event: 76
Pull request review comment event: 3
Pull request review event: 8
Pull request event: 37
Fork event: 1

Last Year

Create event: 11
Release event: 1
Issues event: 21
Watch event: 18
Delete event: 7
Member event: 3
Issue comment event: 83
Push event: 76
Pull request review comment event: 3
Pull request review event: 8
Pull request event: 37
Fork event: 1

Committers

Last synced: 7 months ago

All Time

Total Commits: 520
Total Committers: 36
Avg Commits per committer: 14.444
Development Distribution Score (DDS): 0.694

Past Year

Commits: 35
Committers: 7
Avg Commits per committer: 5.0
Development Distribution Score (DDS): 0.6

Top Committers

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 (Top 20 + Academic)

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

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 312
Total pull requests: 370
Average time to close issues: 6 months
Average time to close pull requests: about 1 month
Total issue authors: 73
Total pull request authors: 38
Average comments per issue: 5.34
Average comments per pull request: 3.09
Merged pull requests: 295
Bot issues: 13
Bot pull requests: 65

Past Year

Issues: 11
Pull requests: 27
Average time to close issues: 2 months
Average time to close pull requests: 24 days
Issue authors: 5
Pull request authors: 5
Average comments per issue: 1.18
Average comments per pull request: 1.56
Merged pull requests: 14
Bot issues: 0
Bot pull requests: 12

View more stats

Top Authors

Issue Authors

jbusecke (92)
rabernat (45)
TomNicholas (20)
dcherian (13)
github-actions[bot] (13)
dhruvbalwada (10)
miniufo (9)
navidcy (5)
NoraLoose (5)
jdldeauna (5)
cspencerjones (4)
jklymak (4)
hdrake (4)
roxyboy (4)
koldunovn (4)

Pull Request Authors

jbusecke (129)
rabernat (65)
TomNicholas (46)
dependabot[bot] (41)
pre-commit-ci[bot] (29)
jdldeauna (9)
hdrake (8)
andersy005 (7)
raehik (4)
navidcy (3)
rcaneill (3)
jatkinson1000 (3)
jrbourbeau (2)
NoraLoose (2)
roxyboy (2)

Top Labels

Issue Labels

enhancement (67) bug (66) Stale (37) question (29) docs (28) keepOpen (21) type: maintenance (14) In Progress (12) siparcs? (8) dependencies (1)

Pull Request Labels

dependencies (41) enhancement (10) docs (5) bug (4) keepOpen (3) In Progress (2) Stale (2) siparcs? (1) github_actions (1)

Packages

Total packages: 4
Total downloads:
- pypi 16,139 last-month
Total docker downloads: 272

Total dependent packages: 16
(may contain duplicates)
Total dependent repositories: 78
(may contain duplicates)
Total versions: 45
Total maintainers: 3

pypi.org: xgcm

General Circulation Model Postprocessing with xarray

Homepage: https://github.com/xgcm/xgcm
Documentation: https://xgcm.readthedocs.io/
License: MIT
Latest release: 0.9.0
published 6 months ago

Versions: 20
Dependent Packages: 12
Dependent Repositories: 18
Downloads: 16,139 Last month
Docker Downloads: 272

Rankings

Dependent packages count: 0.9%

Docker downloads count: 2.9%

Dependent repos count: 3.4%

Average: 3.9%

Stargazers count: 4.6%

Forks count: 5.0%

Downloads: 6.3%

Maintainers (2)

rabernat jbusecke

Last synced: 6 months ago

proxy.golang.org: github.com/xgcm/xgcm

Documentation: https://pkg.go.dev/github.com/xgcm/xgcm#section-documentation
License: mit
Latest release: v0.9.0
published 6 months ago

Versions: 13
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent packages count: 5.4%

Average: 5.6%

Dependent repos count: 5.8%

Last synced: 6 months ago

conda-forge.org: xgcm

Homepage: https://github.com/xgcm/xgcm
License: MIT
Latest release: 0.8.0
published over 3 years ago

Versions: 11
Dependent Packages: 4
Dependent Repositories: 60

Rankings

Dependent repos count: 4.5%

Dependent packages count: 12.5%

Average: 16.1%

Forks count: 21.1%

Stargazers count: 26.2%

Last synced: 6 months ago

spack.io: py-xgcm

General Circulation Model Postprocessing with xarray.

Homepage: https://github.com/xgcm/xgcm
License: []
Latest release: 0.8.1
published 7 months ago

Versions: 1
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent repos count: 0.0%

Average: 27.4%

Dependent packages count: 54.8%

Maintainers (1)

LydDeb

Last synced: 6 months ago

Dependencies

.github/workflows/ci.yaml actions

actions/cache v3.0.11 composite
actions/checkout v3 composite
codecov/codecov-action v3.1.1 composite
conda-incubator/setup-miniconda v2 composite

.github/workflows/pythonpublish.yaml actions

actions/checkout v3 composite
actions/setup-python v4 composite

.github/workflows/twitter_bot.yml actions

ethomson/send-tweet-action v1 composite

setup.py pypi

dask *
future *
numpy *
xarray >=0.20.0

doc/environment.yml conda

cartopy
dask
future
ipykernel
ipython >=8.5.0
matplotlib
netcdf4
numba
numpy
numpydoc
pytest
python 3.9.*
sphinx
sphinx_rtd_theme
xarray

binder/environment.yml pypi

ci/environment.yml pypi