gravity-toolkit

Python tools for working time-variable gravity fields

https://github.com/tsutterley/gravity-toolkit

Science Score: 77.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
    Found 24 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    2 of 2 committers (100.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.1%) to scientific vocabulary

Keywords

geodesy grace grace-fo gravity spherical-harmonics
Last synced: 6 months ago · JSON representation ·

Repository

Python tools for working time-variable gravity fields

Basic Info
Statistics
  • Stars: 39
  • Watchers: 5
  • Forks: 25
  • Open Issues: 11
  • Releases: 14
Topics
geodesy grace grace-fo gravity spherical-harmonics
Created over 8 years ago · Last pushed 7 months ago
Metadata Files
Readme License Citation

README.rst

===============
gravity-toolkit
===============

|License|
|Documentation Status|
|PyPI|
|conda-forge|
|commits-since|
|zenodo|

.. |License| image:: https://img.shields.io/github/license/tsutterley/gravity-toolkit
   :target: https://github.com/tsutterley/gravity-toolkit/blob/main/LICENSE

.. |Documentation Status| image:: https://readthedocs.org/projects/gravity-toolkit/badge/?version=latest
   :target: https://gravity-toolkit.readthedocs.io/en/latest/?badge=latest

.. |PyPI| image:: https://img.shields.io/pypi/v/gravity-toolkit.svg
   :target: https://pypi.python.org/pypi/gravity-toolkit/

.. |conda-forge| image:: https://img.shields.io/conda/vn/conda-forge/gravity-toolkit
   :target: https://anaconda.org/conda-forge/gravity-toolkit

.. |commits-since| image:: https://img.shields.io/github/commits-since/tsutterley/gravity-toolkit/latest
   :target: https://github.com/tsutterley/gravity-toolkit/releases/latest

.. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5156864.svg
   :target: https://doi.org/10.5281/zenodo.5156864

Python tools for obtaining and working with Level-2 spherical harmonic coefficients from the NASA/DLR Gravity Recovery and Climate Experiment (GRACE) and the NASA/GFZ Gravity Recovery and Climate Experiment Follow-On (GRACE-FO) missions

Resources
#########

- `NASA GRACE mission site `_
- `NASA GRACE-FO mission site `_
- `JPL GRACE Tellus site `_
- `JPL GRACE-FO site `_
- `UTCSR GRACE site `_
- `GRACE at the NASA Physical Oceanography Distributed Active Archive Center (PO.DAAC) `_
- `GRACE at the GFZ Information System and Data Center `_

Dependencies
############

- `numpy: Scientific Computing Tools For Python `_
- `scipy: Scientific Tools for Python `_
- `dateutil: powerful extensions to datetime `_
- `PyYAML: YAML parser and emitter for Python `_
- `lxml: processing XML and HTML in Python `_
- `future: Compatibility layer between Python 2 and Python 3 `_
- `matplotlib: Python 2D plotting library `_
- `cartopy: Python package designed for geospatial data processing `_
- `netCDF4: Python interface to the netCDF C library `_
- `h5py: Python interface for Hierarchal Data Format 5 (HDF5) `_
- `geoid-toolkit: Python utilities for calculating geoid heights from static gravity field coefficients `_

References
##########

    T. C. Sutterley, I. Velicogna, and C.-W. Hsu, "Self-Consistent Ice Mass Balance
    and Regional Sea Level From Time-Variable Gravity", *Earth and Space Science*, 7,
    (2020). `doi: 10.1029/2019EA000860 `_

    T. C. Sutterley and I. Velicogna, "Improved estimates of geocenter variability
    from time-variable gravity and ocean model outputs", *Remote Sensing*, 11(18),
    2108, (2019). `doi: 10.3390/rs11182108 `_

    J. Wahr, S. C. Swenson, and I. Velicogna, "Accuracy of GRACE mass estimates",
    *Geophysical Research Letters*, 33(6), L06401, (2006).
    `doi: 10.1029/2005GL025305 `_

    J. Wahr, M. Molenaar, and F. Bryan, "Time variability of the Earth's gravity
    field: Hydrological and oceanic effects and their possible detection using
    GRACE", *Journal of Geophysical Research: Solid Earth*, 103(B12), (1998).
    `doi: 10.1029/98JB02844 `_

    D. Han and J. Wahr, "The viscoelastic relaxation of a realistically stratified
    earth, and a further analysis of postglacial rebound", *Geophysical Journal
    International*, 120(2), (1995).
    `doi: 10.1111/j.1365-246X.1995.tb01819.x `_

Data Repositories
#################

    T. C. Sutterley, I. Velicogna, and C.-W. Hsu, "Ice Mass and Regional Sea Level
    Estimates from Time-Variable Gravity", (2020).
    `doi: 10.6084/m9.figshare.9702338 `_

    T. C. Sutterley and I. Velicogna, "Geocenter Estimates from Time-Variable
    Gravity and Ocean Model Outputs", (2019).
    `doi: 10.6084/m9.figshare.7388540 `_

Download
########

| The program homepage is:
| https://github.com/tsutterley/gravity-toolkit
| A zip archive of the latest version is available directly at:
| https://github.com/tsutterley/gravity-toolkit/archive/main.zip

Disclaimer
##########

This project contains work and contributions from the `scientific community <./CONTRIBUTORS.rst>`_.
This program is not sponsored or maintained by the Universities Space Research Association (USRA),
the Center for Space Research at the University of Texas (UTCSR), the Jet Propulsion Laboratory (JPL),
the German Research Centre for Geosciences (GeoForschungsZentrum, GFZ) or NASA.
It is provided here for your convenience but *with no guarantees whatsoever*.

License
#######

The content of this project is licensed under the `Creative Commons Attribution 4.0 Attribution license `_ and the source code is licensed under the `MIT license `_.

Owner

  • Name: Tyler Sutterley
  • Login: tsutterley
  • Kind: user
  • Location: Seattle, WA
  • Company: @uw-edu Applied Physics Laboratory

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: gravity-toolkit
message: Python tools for working time-variable gravity fields
type: software
authors:
  - given-names: Tyler
    family-names: Sutterley
    affiliation: University of Washington, Applied Physics Laboratory
  - given-names: Isabella
    family-names: Velicogna
    affiliation: University of California, Irvine
  - given-names: Yara
    family-names: Mohajerani
  - given-names: Hugo
    family-names: Lecomte
identifiers:
  - type: doi
    value: 10.5281/zenodo.5156864
    description: Zenodo Archive
repository-code: 'https://github.com/tsutterley/gravity-toolkit'
url: 'https://gravity-toolkit.readthedocs.io'
repository: 'https://pypi.org/project/gravity-toolkit'
repository-artifact: 'https://anaconda.org/conda-forge/gravity-toolkit'
doi: "10.5281/zenodo.5156864"
version: "1.2.4"
date-released: "2025-06-09"
keywords:
  - geodesy
  - gravity
  - spherical harmonics
  - GRACE
  - GRACE-FO
license: MIT

GitHub Events

Total
  • Create event: 12
  • Release event: 2
  • Issues event: 7
  • Watch event: 8
  • Delete event: 9
  • Issue comment event: 6
  • Push event: 19
  • Pull request event: 19
  • Fork event: 5
Last Year
  • Create event: 12
  • Release event: 2
  • Issues event: 7
  • Watch event: 8
  • Delete event: 9
  • Issue comment event: 6
  • Push event: 19
  • Pull request event: 19
  • Fork event: 5

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 191
  • Total Committers: 2
  • Avg Commits per committer: 95.5
  • Development Distribution Score (DDS): 0.021
Past Year
  • Commits: 13
  • Committers: 1
  • Avg Commits per committer: 13.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Tyler Sutterley t****l@u****u 187
tsutterley t****y@n****v 4
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 9
  • Total pull requests: 108
  • Average time to close issues: 5 months
  • Average time to close pull requests: about 8 hours
  • Total issue authors: 6
  • Total pull request authors: 2
  • Average comments per issue: 1.89
  • Average comments per pull request: 0.06
  • Merged pull requests: 107
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 4
  • Pull requests: 12
  • Average time to close issues: about 18 hours
  • Average time to close pull requests: about 16 hours
  • Issue authors: 2
  • Pull request authors: 1
  • Average comments per issue: 1.75
  • Average comments per pull request: 0.0
  • Merged pull requests: 12
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • dlebars (2)
  • tsutterley (2)
  • zhangyuyayaya (2)
  • geodeepak (1)
  • EvgenieLebedev (1)
  • EldrML (1)
  • singhvasu1626 (1)
Pull Request Authors
  • tsutterley (114)
  • hulecom (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 587 last-month
  • Total dependent packages: 1
  • Total dependent repositories: 1
  • Total versions: 8
  • Total maintainers: 1
pypi.org: gravity-toolkit

Python tools for obtaining and working with spherical harmoniccoefficients from the NASA/DLR GRACE and NASA/GFZ GRACE Follow-on missions

  • Versions: 8
  • Dependent Packages: 1
  • Dependent Repositories: 1
  • Downloads: 587 Last month
Rankings
Dependent packages count: 4.7%
Forks count: 9.1%
Stargazers count: 12.4%
Average: 13.9%
Downloads: 21.6%
Dependent repos count: 21.7%
Maintainers (1)
Last synced: 6 months ago

Dependencies

requirements.txt pypi
  • boto3 *
  • cartopy--no-binary =cartopy
  • future *
  • geoid-toolkit *
  • h5py *
  • lxml *
  • matplotlib *
  • netCDF4 *
  • numpy *
  • python-dateutil *
  • pyyaml *
  • scipy *
setup.py pypi
  • line.split *
test/requirements.txt pypi
  • pytest >=4.6
  • pytest-cov *
.github/workflows/python-publish.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/python-request.yml actions
  • actions/checkout v2 composite
  • actions/upload-artifact v2 composite
  • conda-incubator/setup-miniconda v2 composite
Dockerfile docker
  • python 3.9-slim-buster build
.binder/environment.yml conda
  • boto3
  • cartopy
  • future
  • h5py
  • ipympl
  • ipywidgets
  • jupyterlab
  • jupyterlab_widgets
  • lxml
  • matplotlib
  • netcdf4
  • notebook
  • numpy
  • pip
  • python >=3.6
  • python-dateutil
  • pyyaml
  • scipy
  • tk
doc/environment.yml pypi
  • sphinx-argparse >=0.4