Add constants for stretched-grid and lat-lon parameters; Modify code according to suggestions from Pylint

[yantosca]

Name and Institution (Required)

Name: Bob Yantosca
Institution: Harvard + GCST

Describe the update

This PR does the following:

1. Renames the constant skip_these_vars to SKIP_THESE_VARS (as constants in Python should be upper case), and replaced them in various routines.

2. Adds GLOBAL_LL_EXTENT, DEFAULT_SG_STRETCH_FACTOR, DEFAULT_SG_TARGET_LAT, DEFAULT_SG_TARGET_LON, and NO_STRETCH_SG_PARAMS to gcpy/constants.py.

   • Replaced [-180, 180, -90, 90] with GLOBAL_LL_EXTENT in various routines
   • Replaced [1, 170, -90] with NO_STRETCH_SG_PARAMS in various routines

3. Add modifications suggested by Pylint to gcpy/grid.py:

   • Added a shebang line at top of the module
   • Imported GLOBAL_LL_EXTENT and NO_STRETCH_SG_PARAMS from constants.py
   • Edited lines to not be longer than 100 chars where expedient
   • Removed "else" statements after a "return", they're redundant, and re-indented code accordingly
   • Removed lists as default values for keywords; Use None instead, then if the keyword is None, set to its appropriate default value
   • Added PyDoc headers that were missing
   • Renamed routines to conform to Python snake-case name convention:
     • make_grid_LL -> make_grid_ll
     • make_grid_CS -> make_grid_cs
     • make_grid_SG -> make_grid_sg
     • csgrid_GMAO -> csgrid_gmao
     • rotate_sphere_3D -> rotate_sphere_3d
   • Renamed several variables to conform to Python snake-case name convention
   • Removed parentheses after equal signs as directed by Pylint
   • Added cosmetic changes (comments, line breaks, indentations)
   • Added an else block in routine rotate_sphere_3d to raise a ValueError if the rot_axis is not either "x", "y", or "z"

4. Add modifications suggested by Pylint to gcpy/regrid.py

   • Added the shebang line at the top of the module
   • Adjusted import statements to import renamed functions in grid.py
   • Renamed the following functions to better conform to Python snake-case naming convention:
     • make_regridder_l2l --> make_regridder_ll2ll
     • make_regridder_C2L --> make_regridder_cs2ll
     • make_regridder_S2S --> make_regridder_sg2sg
     • make_regridder_l2S --> make_regridder_ll2sg
   • Renamed loop variable regridder to the_regridder to avoid having a name clash with an argument named "regridder"
   • Edited code to make sure lines of code are less than 100 chars.
   • Converted strings using .format() to f-strings
   • Modified code to no longer trap for BaseException
   • Modified code so that lists are not used as default values for keyword arguments. Use None instead and then if the keyword is None, then set it to default values within the program.
   • Renamed local variables to conform to snake-case convention
   • Cosmetic changes (comments, indentation, trimmed whitespace)

5. Add modifications suggested by Pylint to gcpy/cstools.py

   • Updated code to import and use the renamed csgrid_gmao function from gcpy/grid.py
   • Modified the assigment statement for x_lat to use i_vert in (0, 3)
   • Fixed incorrect indentation at line 753

6. Updated gcpy/file_regrid.py to import the renamed make_regridder_* functions from gcpy/grid.py

7. Update gcpy/append_grid_corners.py as follows:

   • Import NO_STRETCH_SG_PARAMS from constants.py and use that instead of hardwired [1, 170, -90]
   • Updated code to use renamed "make_grid_sg" instead of the older "make_grid_SG" function (from grid.py)

8. Update gcpy/raveller_1D.py as follows

   • Now import the renamed make_grid_cs from gcpy/grid.py
   • Added missing PyDoc headers
   • Break lines up so they do no excceed 80 chars
   • Cosmetic changes for readability

Expected changes

This should be a zero-diff change.

Related Github Issue

N/A

[lizziel]

An initial comment I have on this update is to make the default param names more descriptive. Specifically, change DEFAULT_LL_EXTENT to GLOBAL_LL_EXTENT, and DEFAULT_SG_PARAMS to NO_STRETCH_SG_PARAMS. This will make the code more understandable when reading it.

[yantosca]

An initial comment I have on this update is to make the default param names more descriptive. Specifically, change DEFAULT_LL_EXTENT to GLOBAL_LL_EXTENT, and DEFAULT_SG_PARAMS to NO_STRETCH_SG_PARAMS. This will make the code more understandable when reading it.

Thanks @lizziel, I can do this.

[yantosca]

@lizziel @msulprizio: I changed the names of the constants and pushed a couple more fixes.

[yantosca]

@msulprizio @lizziel: This PR has been rebased atop PR #377 (stretched-grid fixes) and #375, and #376 (pypdf==6.0.0)

[yantosca]

I have merged the dev branch as of PR #381 back into feature/update-constants.

[lizziel]

Thanks @yantosca, I will do a re-review this week.

[lizziel]

I think this level of detail in the changelog is a bit too much. Best keep it simple, e.g. "Renamed grid routines to use all lower-case to conform to snake-case naming convention". Same comment for other sections of changelog that have bulleted lists.

[yantosca]

Thanks @lizziel, now updated

[lizziel]

Good to merge!