Skip to content

Commit e81c3d3

Browse files
authored
fix: cycles in regression program (#38)
fix: documentation for spatial programs
1 parent a4b7860 commit e81c3d3

File tree

7 files changed

+13
-5
lines changed

7 files changed

+13
-5
lines changed

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ read-GRACE-harmonics
1111
.. |Language| image:: https://img.shields.io/badge/python-v3.7-green.svg
1212
:target: https://www.python.org/
1313

14-
.. |License| image:: https://img.shields.io/badge/license-MIT-green.svg
14+
.. |License| image:: https://img.shields.io/github/license/tsutterley/read-grace-harmonics
1515
:target: https://github.com/tsutterley/read-GRACE-harmonics/blob/main/LICENSE
1616

1717
.. |Documentation Status| image:: https://readthedocs.org/projects/read-grace-harmonics/badge/?version=latest

doc/source/user_guide/grace_spatial_error.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,13 +88,15 @@ Command Line Options
8888
* ``'GSFC'``: use values from GSFC
8989
* ``'LARES'``: use filtered values from CSR
9090
- ``-U X``, ``--units X``: output units
91+
9192
* ``1``: cm of water thickness
9293
* ``2``: mm of geoid height
9394
* ``3``: mm of elastic crustal deformation [Davis 2004]
9495
* ``4``: microGal gravitational perturbation
9596
* ``5``: mbar equivalent surface pressure
9697
- ``--spacing X``: spatial resolution of output data (dlon,dlat)
9798
- ``--interval X``: output grid interval
99+
98100
* ``1``: (0:360, 90:-90)
99101
* ``2``: (degree spacing/2)
100102
* ``3``: non-global grid (set with defined bounds)

doc/source/user_guide/grace_spatial_maps.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,13 +103,15 @@ Command Line Options
103103
* ``'GSFC'``: use values from GSFC
104104
* ``'LARES'``: use filtered values from CSR
105105
- ``-U X``, ``--units X``: output units
106+
106107
* ``1``: cm of water thickness
107108
* ``2``: mm of geoid height
108109
* ``3``: mm of elastic crustal deformation [Davis 2004]
109110
* ``4``: microGal gravitational perturbation
110111
* ``5``: mbar equivalent surface pressure
111112
- ``--spacing X``: spatial resolution of output data (dlon,dlat)
112113
- ``--interval X``: output grid interval
114+
113115
* ``1``: (0:360, 90:-90)
114116
* ``2``: (degree spacing/2)
115117
* ``3``: non-global grid (set with defined bounds)

doc/source/user_guide/regress_grace_maps.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,15 @@ Command Line Options
2828
- ``-R X``, ``--radius X``: Gaussian smoothing radius (km)
2929
- ``-d``, ``--destripe``: use decorrelation filter (destriping filter)
3030
- ``-U X``, ``--units X``: output units
31+
3132
* ``1``: cm of water thickness
3233
* ``2``: mm of geoid height
3334
* ``3``: mm of elastic crustal deformation [Davis 2004]
3435
* ``4``: microGal gravitational perturbation
3536
* ``5``: mbar equivalent surface pressure
3637
- ``--spacing X``: spatial resolution of output data (dlon,dlat)
3738
- ``--interval X``: output grid interval
39+
3840
* ``1``: (0:360, 90:-90)
3941
* ``2``: (degree spacing/2)
4042
* ``3``: non-global grid (set with defined bounds)
@@ -45,8 +47,8 @@ Command Line Options
4547
* ``'netCDF4'``
4648
* ``'HDF5'``
4749
- ``--redistribute-removed``: redistribute removed mass fields over the ocean
48-
- `--order X`: regression fit polynomial order
49-
- `--cycles X`: regression fit cyclical terms as wavelength in decimal years
50+
- ``--order X``: regression fit polynomial order
51+
- ``--cycles X``: regression fit cyclical terms as wavelength in decimal years
5052
- ``--log``: Output log file for job
5153
- ``-V``, ``--verbose``: verbose output of processing run
5254
- ``-M X``, ``--mode X``: Permissions mode of the files created

doc/source/user_guide/scale_grace_maps.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ Command Line Options
106106
* ``'LARES'``: use filtered values from CSR
107107
- ``--spacing X``: spatial resolution of output data (dlon,dlat)
108108
- ``--interval X``: output grid interval
109+
109110
* ``1``: (0:360, 90:-90)
110111
* ``2``: (degree spacing/2)
111112
- ``--mean-file X``: GRACE/GRACE-FO mean file to remove from the harmonic data

gravity_toolkit/utilities.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -510,6 +510,7 @@ def build_opener(username, password, context=ssl.SSLContext(),
510510
#-- All calls to urllib2.urlopen will now use handler
511511
#-- Make sure not to include the protocol in with the URL, or
512512
#-- HTTPPasswordMgrWithDefaultRealm will be confused.
513+
return opener
513514

514515
#-- PURPOSE: check that entered JPL PO.DAAC/ECCO Drive credentials are valid
515516
def check_credentials(HOST='https://podaac-tools.jpl.nasa.gov'):

scripts/regress_grace_maps.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -501,11 +501,11 @@ def main():
501501
#-- 0: mean
502502
#-- 1: trend
503503
#-- 2: acceleration
504-
parser.add_argument('--order','-o',
504+
parser.add_argument('--order',
505505
type=int, default=2,
506506
help='Regression fit polynomial order')
507507
#-- regression fit cyclical terms
508-
parser.add_argument('--cycle','-c',
508+
parser.add_argument('--cycles',
509509
type=float, default=[0.5,1.0,161.0/365.25], nargs='+',
510510
help='Regression fit cyclical terms')
511511
#-- Output log file for each job in forms

0 commit comments

Comments
 (0)