refactor: change 1 liner default EPSG to 4326 (#379)

* ci: bump version of upload artifact to v4

Author: tsutterley

.github/workflows/python-request.yml

@@ -92,7 +92,7 @@ jobs:
         verbose: true
     - name: Archive code coverage results
       if: steps.secrets.outputs.accessible == 'true'
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: code-coverage-report
         path: ./coverage.xml

README.rst

@@ -115,7 +115,7 @@ Contributing
 ############
 
 This project contains work and contributions from the `scientific community <./CONTRIBUTORS.rst>`_.
-If you would like to contribute to the project, please have a look at the `open issues <https://github.com/tsutterley/pyTMD/issues>`_ and the project `code of conduct <./CODE_OF_CONDUCT.rst>`_.
+If you would like to contribute to the project, please have a look at the `open issues <https://github.com/tsutterley/pyTMD/issues>`_ and `discussions board <https://github.com/tsutterley/pyTMD/discussions>`_.
 
 Credits
 #######

pyTMD/compute.py

@@ -220,7 +220,7 @@ def tide_elevations(
         CROP: bool = False,
         BOUNDS: list | np.ndarray | None = None,
         BUFFER: int | float | None = None,
-        EPSG: str | int = 3031,
+        EPSG: str | int = 4326,
         EPOCH: list | tuple = (2000, 1, 1, 0, 0, 0),
         TYPE: str | None = 'drift',
         TIME: str = 'UTC',
@@ -261,7 +261,7 @@ def tide_elevations(
         Boundaries for cropping tide model data
     BUFFER: int, float or NoneType, default None
         Buffer distance for cropping tide model data
-    EPSG: int, default: 3031 (Polar Stereographic South, WGS84)
+    EPSG: int, default: 4326 (WGS84 Latitude and Longitude)
         Input coordinate system
     EPOCH: tuple, default (2000,1,1,0,0,0)
         Time period for calculating delta times
@@ -448,7 +448,7 @@ def tide_currents(
         CROP: bool = False,
         BOUNDS: list | np.ndarray | None = None,
         BUFFER: int | float | None = None,
-        EPSG: str | int = 3031,
+        EPSG: str | int = 4326,
         EPOCH: list | tuple = (2000, 1, 1, 0, 0, 0),
         TYPE: str | None = 'drift',
         TIME: str = 'UTC',
@@ -487,7 +487,7 @@ def tide_currents(
         Boundaries for cropping tide model data
     BUFFER: int, float or NoneType, default None
         Buffer distance for cropping tide model data
-    EPSG: int, default: 3031 (Polar Stereographic South, WGS84)
+    EPSG: int, default: 4326 (WGS84 Latitude and Longitude)
         Input coordinate system
     EPOCH: tuple, default (2000,1,1,0,0,0)
         Time period for calculating delta times
@@ -667,7 +667,7 @@ def tide_masks(x: np.ndarray, y: np.ndarray,
         MODEL: str | None = None,
         GZIP: bool = False,
         DEFINITION_FILE: str | pathlib.Path | None = None,
-        EPSG: str | int = 3031,
+        EPSG: str | int = 4326,
         METHOD: str = 'spline'
     ):
     """
@@ -687,7 +687,7 @@ def tide_masks(x: np.ndarray, y: np.ndarray,
         Tide model files are gzip compressed
     DEFINITION_FILE: str or NoneType, default None
         Tide model definition file for use
-    EPSG: str or int, default: 3031 (Polar Stereographic South, WGS84)
+    EPSG: str or int, default: 4326 (WGS84 Latitude and Longitude)
         Input coordinate system
     METHOD: str, default 'spline'
         interpolation method
@@ -795,7 +795,7 @@ def tide_masks(x: np.ndarray, y: np.ndarray,
 # PURPOSE: compute long-period equilibrium tidal elevations
 def LPET_elevations(
         x: np.ndarray, y: np.ndarray, delta_time: np.ndarray,
-        EPSG: str | int = 3031,
+        EPSG: str | int = 4326,
         EPOCH: list | tuple = (2000, 1, 1, 0, 0, 0),
         TYPE: str | None = 'drift',
         TIME: str = 'UTC',
@@ -812,7 +812,7 @@ def LPET_elevations(
         y-coordinates in projection EPSG
     delta_time: np.ndarray
         seconds since EPOCH or datetime array
-    EPSG: int, default: 3031 (Polar Stereographic South, WGS84)
+    EPSG: int, default: 4326 (WGS84 Latitude and Longitude)
         Input coordinate system
     EPOCH: tuple, default (2000,1,1,0,0,0)
         Time period for calculating delta times
@@ -900,7 +900,7 @@ def LPET_elevations(
 # following IERS Convention (2010) guidelines
 def LPT_displacements(
         x: np.ndarray, y: np.ndarray, delta_time: np.ndarray,
-        EPSG: str | int = 3031,
+        EPSG: str | int = 4326,
         EPOCH: list | tuple = (2000, 1, 1, 0, 0, 0),
         TYPE: str | None = 'drift',
         TIME: str = 'UTC',
@@ -921,7 +921,7 @@ def LPT_displacements(
         y-coordinates in projection EPSG
     delta_time: np.ndarray
         seconds since EPOCH or datetime array
-    EPSG: int, default: 3031 (Polar Stereographic South, WGS84)
+    EPSG: int, default: 4326 (WGS84 Latitude and Longitude)
         Input coordinate system
     EPOCH: tuple, default (2000,1,1,0,0,0)
         Time period for calculating delta times
@@ -1100,7 +1100,7 @@ def LPT_displacements(
 # following IERS Convention (2010) guidelines
 def OPT_displacements(
         x: np.ndarray, y: np.ndarray, delta_time: np.ndarray,
-        EPSG: str | int = 3031,
+        EPSG: str | int = 4326,
         EPOCH: list | tuple = (2000, 1, 1, 0, 0, 0),
         TYPE: str | None = 'drift',
         TIME: str = 'UTC',
@@ -1122,7 +1122,7 @@ def OPT_displacements(
         y-coordinates in projection EPSG
     delta_time: np.ndarray
         seconds since EPOCH or datetime array
-    EPSG: int, default: 3031 (Polar Stereographic South, WGS84)
+    EPSG: int, default: 4326 (WGS84 Latitude and Longitude)
         Input coordinate system
     EPOCH: tuple, default (2000,1,1,0,0,0)
         Time period for calculating delta times
@@ -1328,7 +1328,7 @@ def OPT_displacements(
 # PURPOSE: compute solid earth tidal elevations
 def SET_displacements(
         x: np.ndarray, y: np.ndarray, delta_time: np.ndarray,
-        EPSG: str | int = 3031,
+        EPSG: str | int = 4326,
         EPOCH: list | tuple = (2000, 1, 1, 0, 0, 0),
         TYPE: str | None = 'drift',
         TIME: str = 'UTC',
@@ -1349,7 +1349,7 @@ def SET_displacements(
         y-coordinates in projection EPSG
     delta_time: np.ndarray
         seconds since EPOCH or datetime array
-    EPSG: int, default: 3031 (Polar Stereographic South, WGS84)
+    EPSG: int, default: 4326 (WGS84 Latitude and Longitude)
         Input coordinate system
     EPOCH: tuple, default (2000,1,1,0,0,0)
         Time period for calculating delta times

pyTMD/predict.py

@@ -108,7 +108,8 @@ def map(t: float | np.ndarray,
         corrections: str = 'OTIS'
     ):
     """
-    Predict tides at a single time using harmonic constants :cite:p:`Egbert:2002ge`
+    Predict tides at a single time using harmonic
+    constants :cite:p:`Egbert:2002ge`
 
     Parameters
     ----------
@@ -280,8 +281,9 @@ def infer_minor(
     ):
     """
     Infer the tidal values for minor constituents using their
-    relation with major constituents :cite:p:`Doodson:1941td` :cite:p:`Schureman:1958ty`
-    :cite:p:`Foreman:1989dt` :cite:p:`Egbert:2002ge`
+    relation with major constituents :cite:p:`Doodson:1941td`
+    :cite:p:`Schureman:1958ty` :cite:p:`Foreman:1989dt`
+    :cite:p:`Egbert:2002ge`
 
     Parameters
     ----------
@@ -621,7 +623,8 @@ def _infer_diurnal(
     Infer the tidal values for diurnal minor constituents
     using their relation with major constituents taking into
     account resonance due to free core nutation
-    :cite:p:`Munk:1966go` :cite:p:`Ray:2017jx` :cite:p:`Wahr:1981if` :cite:p:`Cartwright:1973em`
+    :cite:p:`Munk:1966go` :cite:p:`Ray:2017jx` :cite:p:`Wahr:1981if`
+    :cite:p:`Cartwright:1973em`
 
     Parameters
     ----------
@@ -1259,7 +1262,8 @@ def solid_earth_tide(
     ):
     """
     Compute the solid Earth tides due to the gravitational attraction of
-    the moon and sun :cite:p:`Mathews:1991kv` :cite:p:`Mathews:1997js` :cite:p:`Ries:1992ip` :cite:p:`Wahr:1981ea`
+    the moon and sun :cite:p:`Mathews:1991kv` :cite:p:`Mathews:1997js`
+    :cite:p:`Ries:1992ip` :cite:p:`Wahr:1981ea`
 
     Parameters
     ----------

pyproject.toml

@@ -101,3 +101,6 @@ omit = [
 [tool.coverage.report]
 show_missing = true
 precision = 2
+
+[tool.ruff]
+line-length = 80

test/test_arguments.py

@@ -853,7 +853,8 @@ def test_parse_tables():
         CTE = pyTMD.arguments._parse_tide_potential_table(table)
         for i, line in enumerate(CTE):
             # convert Doodson number to Cartwright numbers
-            tau, s, h, p, n, pp = pyTMD.arguments._from_doodson_number(line['DO'])
+            DO = line['DO']
+            tau, s, h, p, n, pp = pyTMD.arguments._from_doodson_number(DO)
             assert tau == line['tau'], line
             assert s == line['s'], line
             assert h == line['h'], line

test/test_atlas_read.py

@@ -53,7 +53,11 @@
 
 # PURPOSE: Download TPXO8 ATLAS compact constituents from AWS S3 bucket
 # @pytest.fixture(scope="module", autouse=True)
-def download_TPXO8(aws_access_key_id,aws_secret_access_key,aws_region_name):
+def download_TPXO8(
+        aws_access_key_id,
+        aws_secret_access_key,
+        aws_region_name
+    ):
     # get aws session object
     session = boto3.Session(
         aws_access_key_id=aws_access_key_id,
@@ -67,8 +71,11 @@ def download_TPXO8(aws_access_key_id,aws_secret_access_key,aws_region_name):
     model_directory = filepath.joinpath('tpxo8_atlas')
     # recursively create model directory
     model_directory.mkdir(parents=True, exist_ok=True)
+    model_files = ['grid_tpxo8atlas_30_v1',
+        'hf.tpxo8_atlas_30_v1',
+        'uv.tpxo8_atlas_30_v1']
     # retrieve each model file from s3
-    for f in ['grid_tpxo8atlas_30_v1','hf.tpxo8_atlas_30_v1','uv.tpxo8_atlas_30_v1']:
+    for f in model_files:
         # retrieve constituent file
         obj = bucket.Object(key=posixpath.join('tpxo8_atlas',f))
         response = obj.get()
@@ -83,7 +90,11 @@ def download_TPXO8(aws_access_key_id,aws_secret_access_key,aws_region_name):
 
 # PURPOSE: Download TPXO9 ATLAS V2 netCDF constituents from AWS S3 bucket
 @pytest.fixture(scope="module", autouse=True)
-def download_TPXO9_v2(aws_access_key_id,aws_secret_access_key,aws_region_name):
+def download_TPXO9_v2(
+        aws_access_key_id,
+        aws_secret_access_key,
+        aws_region_name
+    ):
     # get aws session object
     session = boto3.Session(
         aws_access_key_id=aws_access_key_id,
@@ -94,13 +105,14 @@ def download_TPXO9_v2(aws_access_key_id,aws_secret_access_key,aws_region_name):
     bucket = s3.Bucket('pytmd')
 
     # model parameters for TPXO9-atlas-v2
-    model = pyTMD.io.model(filepath,format='ATLAS-netcdf',compressed=True,
-        verify=False).elevation('TPXO9-atlas-v2-nc')
+    model = pyTMD.io.model(filepath,compressed=True,verify=False
+        ).elevation('TPXO9-atlas-v2-nc')
     # recursively create model directory
     model_directory = model.model_file[0].parent
     model_directory.mkdir(parents=True, exist_ok=True)
     # retrieve grid file from s3
-    obj = bucket.Object(key=posixpath.join('TPXO9_atlas_v2',model.grid_file.name))
+    key = posixpath.join('TPXO9_atlas_v2',model.grid_file.name)
+    obj = bucket.Object(key=key)
     response = obj.get()
     # save grid data
     with model.grid_file.open(mode='wb') as destination:
@@ -109,7 +121,8 @@ def download_TPXO9_v2(aws_access_key_id,aws_secret_access_key,aws_region_name):
     # retrieve each model file from s3
     for model_file in model.model_file:
         # retrieve constituent file
-        obj = bucket.Object(key=posixpath.join('TPXO9_atlas_v2',model_file.name))
+        key = posixpath.join('TPXO9_atlas_v2',model_file.name)
+        obj = bucket.Object(key=key)
         response = obj.get()
         # save constituent data
         with model_file.open(mode='wb') as destination:
@@ -131,8 +144,12 @@ def test_read_TPXO9_v2(METHOD, EXTRAPOLATE, CROP):
     # model grid file
     grid_file = model_directory.joinpath('grid_tpxo9_atlas_30_v2.nc.gz')
     # constituent files included in test
-    model_files = ['h_m2_tpxo9_atlas_30_v2.nc.gz','h_s2_tpxo9_atlas_30_v2.nc.gz',
-        'h_k1_tpxo9_atlas_30_v2.nc.gz','h_o1_tpxo9_atlas_30_v2.nc.gz']
+    model_files = [
+        'h_m2_tpxo9_atlas_30_v2.nc.gz',
+        'h_s2_tpxo9_atlas_30_v2.nc.gz',
+        'h_k1_tpxo9_atlas_30_v2.nc.gz',
+        'h_o1_tpxo9_atlas_30_v2.nc.gz'
+    ]
     model_file = [model_directory.joinpath(m) for m in model_files]
     constituents = ['m2','s2','k1','o1']
     TYPE = 'z'
@@ -176,8 +193,12 @@ def test_compare_TPXO9_v2(METHOD):
     # model grid file
     grid_file = model_directory.joinpath('grid_tpxo9_atlas_30_v2.nc.gz')
     # constituent files included in test
-    model_files = ['h_m2_tpxo9_atlas_30_v2.nc.gz','h_s2_tpxo9_atlas_30_v2.nc.gz',
-        'h_k1_tpxo9_atlas_30_v2.nc.gz','h_o1_tpxo9_atlas_30_v2.nc.gz']
+    model_files = [
+        'h_m2_tpxo9_atlas_30_v2.nc.gz',
+        'h_s2_tpxo9_atlas_30_v2.nc.gz',
+        'h_k1_tpxo9_atlas_30_v2.nc.gz',
+        'h_o1_tpxo9_atlas_30_v2.nc.gz'
+    ]
     model_file = [model_directory.joinpath(m) for m in model_files]
     TYPE = 'z'
     SCALE = 1.0
@@ -316,8 +337,12 @@ def test_verify_TPXO9_v2(METHOD, EXTRAPOLATE, CROP):
     # model grid file
     grid_file = model_directory.joinpath('grid_tpxo9_atlas_30_v2.nc.gz')
     # constituent files included in test
-    model_files = ['h_m2_tpxo9_atlas_30_v2.nc.gz','h_s2_tpxo9_atlas_30_v2.nc.gz',
-        'h_k1_tpxo9_atlas_30_v2.nc.gz','h_o1_tpxo9_atlas_30_v2.nc.gz']
+    model_files = [
+        'h_m2_tpxo9_atlas_30_v2.nc.gz',
+        'h_s2_tpxo9_atlas_30_v2.nc.gz',
+        'h_k1_tpxo9_atlas_30_v2.nc.gz',
+        'h_o1_tpxo9_atlas_30_v2.nc.gz'
+    ]
     model_file = [model_directory.joinpath(m) for m in model_files]
     constituents = ['m2','s2','k1','o1']
     model_format = 'ATLAS-netcdf'
@@ -413,7 +438,8 @@ def test_definition_file(MODEL):
     model = pyTMD.io.model(filepath,compressed=True).elevation(MODEL)
     # create model definition file
     fid = io.StringIO()
-    attrs = ['name','format','grid_file','model_file','compressed','type','scale']
+    attrs = ['name','format','grid_file','model_file',
+        'compressed','type','scale']
     d = model.to_dict(fields=attrs, serialize=True)
     json.dump(d, fid)
     fid.seek(0)

test/test_coordinates.py

@@ -19,10 +19,12 @@
 @pytest.mark.parametrize("MODEL", models)
 # PURPOSE: verify forward and backwards coordinate conversions
 def test_coordinates(MODEL):
-    startlat = {'Gr1km-v2':60,'CATS2008':-60,'AOTIM-5-2018':60,'TPXO9-atlas-v5':90}
-    endlat = {'Gr1km-v2':70,'CATS2008':-70,'AOTIM-5-2018':70,'TPXO9-atlas-v5':-90}
-    is_geographic = {'Gr1km-v2':False,'CATS2008':False,
-        'AOTIM-5-2018':False,'TPXO9-atlas-v5':True}
+    startlat = {'Gr1km-v2':60, 'CATS2008':-60,
+        'AOTIM-5-2018':60,'TPXO9-atlas-v5':90}
+    endlat = {'Gr1km-v2':70, 'CATS2008':-70,
+        'AOTIM-5-2018':70,'TPXO9-atlas-v5':-90}
+    is_geographic = {'Gr1km-v2':False, 'CATS2008':False,
+        'AOTIM-5-2018':False, 'TPXO9-atlas-v5':True}
     i1 = np.arange(-180,180+1,1)
     i2 = np.linspace(startlat[MODEL],endlat[MODEL],len(i1))
     # convert latitude and longitude to and from projection