v1.2.5

Summary:
With this release, we organized all of the related project scripts into subdirectories. We also modernized and organized the documentation. Operationally, GFZ has retired their ftp access service, and so we updated the GFZ access routines to use their new https access point. We simplified development builds to use pixi, which allows a nice streamlined environment.

Itemized Changes:

• feat: added options to run SLF from input spatial fields (#158)
• fix: add netCDF4 to default requirements (#158)
• fix: copy latitude and longitude as float64 for numpy 2.0 stability (#158)
• feat: added option to set the density of water in g/cm^3 (#158)
• fix: earthdata link for #160 (#162)
• fix: change default endpoint in cumulus to data for #161 (#162)
• ci: add paths to check if needing to run tests (#162)
• docs: notebooks in documentation (#163)
• fix: docstring for UCI geocenter files
• refactor: organize scripts into subdirectories (#165)
• docs: add logo and color scheme (#165)
• docs: add annotations (#165)
• docs: add code of conduct (#165)
• docs: add project pages (#165)
• refactor: use pyproject.toml for builds (#165)
• docs: adjust style.css
• docs: add spherical harmonic plots (#166)
• docs: add cartopy to environment.yml (#166)
• chore: Delete leap-seconds.list
• ci: use pixi for builds (#167)
• docs: use pixi for builds (#167)
• chore: Delete environment.yml
• refactor: GFZ ISDC ftp server is being retired (#168)
• docs: fix testing description
• docs: fix contributors (now markdown)
• fix: switch from_gfz to https as ftp server is retired (#169)

Full Changelog: 1.2.4...1.2.5

v1.2.4

Summary:
Verifies that the land-sea mask objects are fetched from git-lfs when running CI and when building for pypi. First release after publishing on conda-forge 🎉

Itemized Changes:

• test: add check for reading land-sea masks (#157)
• ci: verify that git-lfs is used (#157)
• docs: add badge for conda-forge (#157)

Full Changelog: 1.2.3...1.2.4

v1.2.3

Updates the MANIFEST.in file for fixes the build on conda-forge

v1.2.2

Summary:
Fixes CMR searches after deprecation of PO.DAAC drive and scrolling. Adds a function for getting the latest GSFC mascon fields. Some minor updates to the geocenter program. Updates to the continuous integration to use mamba and improve performance.

Itemized Changes:

• feat: add land_stokes function to parallel ocean_stokes (#138)
• docs: update font and style of flowchart (#138)
• feat: add zorder to quick mascon plot (#138)
• fix: environment for auto update (#138)
• feat: add string representation of major classes (#139)
• feat: add raster program for GRACE projected fields (#139)
• ci: bump versions of imported actions (#139)
• ci: use mamba for builds (#140)
• docs: use micromamba for RTD builds (#140)
• fix: check that collection metadata urls exist (#141)
• fix: don't restrict version number to a set list of presently available (#141)
• feat: output netCDF4 files for all geocenter runs (#142)
• fix: prevent double printing of filenames when using debug (#143)
• refactor: simplify I-matrix and G-matrix calculations (#143)
• feat: add widget for setting endpoint for accessing PODAAC data (#145)
• fix: added check to verify access to s3 buckets (#145)
• feat: add Greenland 5 map code (#145)
• fix: autoupdate files (#145)
• fix: add ssl context update for deprecation (#145)
• fix: spelling mistakes (#145)
• fix: place time and month variables in try/except block (#145)
• feat: added argument for products in CMR shortname query (#145)
• fix: increase mask buffer to twice the smoothing radius in raster (#145)
• refactor: use wrapper to importlib for optional dependencies (#146)
• feat: make classes subscriptable and allow item assignment (#146)
• feat: add lomb scargle wrapper program (#146)
• refactor: remove timescale class and leap second calculations (#146)
• fix: update CMR search utility to replace deprecated scrolling (#147)
• feat: add function to scrape GSFC website for GRACE mascons (#149)
• fix: endpoint for TN-13 and TN-14 is now documentation (#148)
• fix: deprecated widget object copies for #150 (#151)
• fix: add polar argument for x == +/-1 to prevent drift (#151)
• feat: allow reading love numbers where degree is infinite (#151)
• fix: check if the GRACE/GRACE-FO files are gfc format for #152 (#153)
• docs: use sphinxcontrib-bibtex for citations (#154)
• fix: deprecated tick label resizing (#155)
• docs: merge multiple bibtex citations together (#156)

Full Changelog: 1.2.1...1.2.2

v1.2.1

Summary:
Adds more statistical programs, generic mapping programs, and a prototype geostrophic current program. Refactors path operations to use pathlib. Updates with the retirement of PO.DAAC Drive.

Itemized Changes:

• feat: add global dealiasing uplift program (#113)
• feat: debug-level logging of member names and header lines (#113)
• feat: add extend_matrix function (#113)
• feat: add wrap_longitudes to tools (#113)
• feat: add mapping programs from Sutterley et al. 2019 and 2020 (#114)
• feat: include option to not compensate for elastic deformation for #37 (#115)
• feat: added regex formatting for CNES GRGS harmonics (#115)
• feat: added functions for getting unit attributes for known types (#116)
• feat: add initial geostrophic current program (#117)
• feat: add angular velocity of the Earth to units (#117)
• feat: add solver option to geocenter and mascon programs (#118)
• feat: allow option 0 in combine_harmonics.py for no unit conversion (#118)
• feat: add piecewise regression program (#120)
• feat: add additional fit term options to regression programs (#120)
• feat: split S2 tidal aliasing terms into GRACE and GRACE-FO eras (#121)
• feat: add reify decorator for evaluation of properties (#121)
• feat: split S2 tidal aliasing terms into GRACE and GRACE-FO eras in more programs (#123)
• feat: add functions to retrieve and revoke Earthdata tokens (#125)
• feat: more operatations on spatial error if in possible data keys (#125)
• feat: can choose different tidal aliasing periods (#132)
• feat: add timescale class for converting between time scales (#133)
• feat: add functions for retrieving leap seconds from NIST or IERF servers
• refactor: use formatting for reading from date file (#121)
• refactor: use pathlib to define and operate on paths (#123)
• refactor: in monthly dealiasing, read data into flattened harmonics objects (#113)
• refactor: convert shape and ndim to harmonics and spatial class properties (#113)
• refactor: updated inputs to spatial from_ascii function (#113)
• refactor: merge regional plot programs into single program (#114)
• refactor: add descriptive file-level attributes to output netCDF4/HDF5 files (#115)
• refactor: use fit module for getting tidal aliasing terms (#125)
• refactor: modified custom units in spherical caps and disc loads (#129)
• fix: scale and dimensions (#113)
• fix: spatial extend_matrix (#113)
• fix: output file append in regress_grace_maps.py (#114)
• fix: place cmap set in try/except (#114)
• fix: set case_insensitive_filename to None if filename is empty (#117)
• fix: remove_label in tools.py (#118)
• fix: frame in geostrophic currents notebook (#118)
• fix: allow love numbers to be None for custom units case (#119)
• fix: headers in plot script documentation (#119)
• fix: PO.DAAC now has different openers for s3 and data endpoints (#120)
• fix: add podaac cumulus test and skip drive (#120)
• fix: bump GFZ GravIS files to Release-03 (#120)
• fix: remove deprecated PO.DAAC Drive sync programs (#123)
• fix: append amplitude and phase titles when creating flags (#127)
• fix: GRACE/GRACE-FO months in drift function for #131 (#132)
• docs: add documentation for graphing programs (#114)
• docs: improve typing for variables in docstrings (#116)
• docs: add notes about Shida numbers (#119)
• docs: remove binder links 😢 (#120)
• docs: remove references to deprecated sync programs (#123)
• docs: scrub PO.DAAC Drive and WebDAV (#126)

Full Changelog: 1.2.0...1.2.1

v1.2.0

First release under the new gravity-toolkit repository name 🎉

Summary: Provides additional Load Love numbers for estimating the elastic responses to surface load changes. Generalization of HDF5 and netCDF4 io functions for more variables and attributes. Updates for calculating and working with GRACE/GRACE-FO scaling factors (Landerer and Swenson, 2012). Fixes to harmonics and units classes for operating on the degree-0 and single degree cases.

• refactor: new repo name (#99)
• refactor: simplified unit factors in spherical caps and disc loads (#111)
• refactor: remove deprecated functions (#112)
• feat: added function to retrieve named units (#102)
• feat: added wrapper function for smoothing and converting to output units (#102)
• feat: add PREM hard and soft sediment love numbers (#104)
• feat: data class for load love numbers with attributes for model (#105)
• feat: customizable file-level attributes to netCDF4 and HDF5 (#106)
• feat: add root attributes to output netCDF4 and HDF5 files (#107)
• feat: add indexing of filenames to object iterators (#109)
• feat: new scaling_factors inheritance of spatial class (#110)
• fix: only attempt to squeeze from final dimension in harmonics objects (#108)
• fix: case insensitive searching for HDF5 and netCDF4 GIA attributes (#111)
• fix: verify warnings have type and filtered after (#101)
• fix: set custom units as top option in if/else statements (#102)
• fix: expand harmonics case where data is a single degree (#103)
• fix: harmonics case where maximum spherical harmonic degree is 0 (#103)
• fix: units case where maximum spherical harmonic degree is 0 (#103)
• fix: load love number case with maximum spherical harmonic degree is 0 (#103)
• docs: update docstrings (#100)
• docs: slimmer builds by placing imports within try/except (#111)
• test: add test for getting units (#102)

Full Changelog: 1.1.0...1.2.0

v1.1.0

Some major refactoring of the code base to update syntax and structure
For now, the code should be the backwards compatible with deprecation warnings

• feat: adding CMR queries for TN files (#89)
• feat: add git utilities for managing repositories (#93)
• feat: add netCDF4/HDF5 source attribute to harmonics and spatial classes (#93)
• feat: can iterate over harmonics, spatial and geocenter objects (#97)
• fix: expose GSFC SLR 5x5 url as option in download (#91)
• fix: set default GIA parameters, title, reference and url as None (#97)
• refactor: use f-strings for formatting verbose or ascii output (#89)
• refactor: camel_case updates for #90 (#91)
• refactor: comment format to try to match flake8 styling for #90 (#92)
• refactor: implicit import as gravtk (#93)
• refactor: use attributes kwards for output to nc/hdf5 (#93)
• refactor: SLR, plm and time series functions (#98)
• docs: use sphinx-argparse v0.4.0 with exec search (#89)
• docs: slimmer build to prevent overutilization of resources (#95)
• docs: remove '.py' from function titles (#96)
• test: add test for comparing GIA reads (#93)
• test: single implicit import of gravity_toolkit (#98)

Full Changelog: 1.0.2.7...1.1.0

v1.0.2.7

Bug fixes and new features for running Versions 0 and 1 of RL06

• feat: add program for overwriting the GRACE/GRACE-FO index
• feat: Dynamically select newest version of granules for index
• feat: add GSFC SLR 5x5 download function
• feat: add option to replace degree 4 zonal harmonics with SLR
• feat: added more time parsing for longer periods
• docs: updated structure of documentation
• fix: expand mask variable within if statement
• fix: place ipython and tkinter imports within try/except
• fix: remove cartopy for slimmer build
• fix: create mask for output gridded variables
• fix: version check for mission in GFZ ftp sync

v1.0.2.6

Working release for submitting to pypi

• Updated documentation using autodoc
• Add initial versions of geocenter calculation program

1.0.2.5

Working release for obtaining and working with Level-2 Gravity Recovery and Climate Experiment (GRACE) and GRACE Follow-On spherical harmonic data in Python. Release corresponding with submission to the third Ice Sheet Mass Balance Intercomparison Exercise (IMBIE3).