refactor: rename grid spacing functions

Author: Hem-W

dominosee/grid/__init__.py

@@ -27,8 +27,8 @@
     cart_to_geo,
     geo_to_cart,
     geo_distance,
-    deg_to_eq_spacing,
-    eq_spacing_to_deg,
+    deg_to_equatorial_distance,
+    equatorial_distance_to_deg,
     neighbour_distance,
 )
 
@@ -48,7 +48,7 @@
     'cart_to_geo',
     'geo_to_cart',
     'geo_distance',
-    'deg_to_eq_spacing',
-    'eq_spacing_to_deg',
+    'deg_to_equatorial_distance',
+    'equatorial_distance_to_deg',
     'neighbour_distance',
 ]

dominosee/grid/grid.py

@@ -160,7 +160,7 @@ def create_grid(self) -> Dict[str, np.ndarray]:
 
     def get_distance_equator(self):
         """Return distance between points at the equator."""
-        d_lon = deg_to_eq_spacing(self.grid_step_lon, radius=6371)
+        d_lon = deg_to_equatorial_distance(self.grid_step_lon, radius=6371)
         return d_lon
 
     @staticmethod
@@ -220,7 +220,7 @@ def create_grid(self): # TODO: 确认高斯网格的起止点
 
     def get_distance_equator(self):
         """Return distance between points at the equator."""
-        d_lon = deg_to_eq_spacing(self.grid_step_lon, radius=6371)
+        d_lon = deg_to_equatorial_distance(self.grid_step_lon, radius=6371)
         return d_lon
 
 
@@ -742,7 +742,7 @@ def to_cdo_gridfile(self, filepath = None, out_vertex = False):
 
     def to_gridfile(self, filepath = None, out_vertex = False):
         if filepath is None:
-            filepath = f'feketegrid_{self.num_points}_{self.num_iter}.txt'
+            filepath = f'feketegrid_n{self.num_points}_it{self.num_iter}.txt'
         with open(filepath, 'w') as fp:
             fp.write("gridtype\t= unstructured\n")
             fp.write(f"gridsize\t= {self.num_points}\n")
@@ -884,9 +884,7 @@ def spherical_distance_objective(rotation_vector):
         final_points = final_points / np.linalg.norm(final_points, axis=1, keepdims=True)
 
         # Convert back to spherical coordinates
-        new_lon, new_lat = cart_to_geo(final_points[:, 0], 
-                                               final_points[:, 1], 
-                                               final_points[:, 2])
+        new_lon, new_lat = cart_to_geo(final_points[:, 0], final_points[:, 1], final_points[:, 2])
 
         return {
             'lon': new_lon, 
@@ -1175,8 +1173,7 @@ def geo_distance(lon1: Union[float, np.ndarray], lat1: Union[float, np.ndarray],
     return radius * c
 
 
-
-def deg_to_eq_spacing(grid_step: float, radius: float = 6371) -> float:
+def deg_to_equatorial_distance(grid_step: float, radius: float = 6371) -> float:
     """Convert angular grid resolution (degrees) to equivalent distance at the equator (km).
     
     Args:
@@ -1194,7 +1191,8 @@ def deg_to_eq_spacing(grid_step: float, radius: float = 6371) -> float:
 
     return geo_distance(0, 0, grid_step, 0, radius=radius)
 
-def eq_spacing_to_deg(distance: float, radius: float = 6371) -> float:
+
+def equatorial_distance_to_deg(distance: float, radius: float = 6371) -> float:
     """Convert equatorial distance (km) to equivalent angular grid resolution (degrees).
     
     Args:
@@ -1212,7 +1210,7 @@ def eq_spacing_to_deg(distance: float, radius: float = 6371) -> float:
 
     return distance * 360 / (2 * np.pi * radius)
 
-# def min_dists(grid1, grid2 = None):
+# def min_dists(grid1, grid2 = None): TODO: implement grid2 but I dont know why need it
 #     if grid2 is None:
 #         lon1, lon2 = grid1['lon'], grid1['lon']
 #         lat1, lat2 = grid1['lat'], grid1['lat']

tests/test_fekete_grid.py

@@ -4,7 +4,7 @@
 import numpy as np
 import pytest
 
-from dominosee.grid import FeketeGrid, deg_to_eq_spacing, distance_to_grid_num, grid_num_to_distance
+from dominosee.grid import FeketeGrid, deg_to_equatorial_distance, distance_to_grid_num, grid_num_to_distance
 
 
 def test_fekete_grid_5_degree_resolution():
@@ -16,7 +16,7 @@ def test_fekete_grid_5_degree_resolution():
     """
     # Calculate distance equivalent to 5 degrees at equator
     target_resolution_deg = 5.0
-    target_distance_km = deg_to_eq_spacing(target_resolution_deg, radius=6371)
+    target_distance_km = deg_to_equatorial_distance(target_resolution_deg, radius=6371)
 
     # Calculate number of points needed for this resolution
     num_points = distance_to_grid_num(target_distance_km)
@@ -67,7 +67,7 @@ def test_fekete_grid_with_iterations():
     to verify the improvement functionality works.
     """
     # Use a smaller grid for faster testing with iterations
-    target_distance_km = deg_to_eq_spacing(10.0, radius=6371)  # 10-degree resolution
+    target_distance_km = deg_to_equatorial_distance(10.0, radius=6371)  # 10-degree resolution
     num_points = distance_to_grid_num(target_distance_km)
 
     # Create grid with a few iterations