Merge pull request #5 from gregory-halverson-jpl/main

explicit names

Author: gregory-halverson-jpl

README.md

@@ -30,7 +30,7 @@ Converts solar apparent time to Coordinated Universal Time (UTC) at given longit
 **Returns:**
 - datetime: The UTC time at the given longitude.
 
-### `UTC_offset_hours(geometry: rasters.RasterGeometry) -> rasters.Raster`
+### `UTC_offset_hours_for_area(geometry: rasters.RasterGeometry) -> rasters.Raster`
 
 Calculates the UTC offset in hours for an area defined by a `RasterGeometry` object from the `rasters` package.
 
@@ -40,7 +40,7 @@ Calculates the UTC offset in hours for an area defined by a `RasterGeometry` obj
 **Returns:**
 - rasters.Raster: The UTC offset in hours.
 
-### `day_of_year(time_UTC: datetime, geometry: rasters.RasterGeometry) -> rasters.Raster`
+### `solar_day_of_year_for_area(time_UTC: datetime, geometry: rasters.RasterGeometry) -> rasters.Raster`
 
 Calculates the day of the year for a given UTC time and an area defined by a `RasterGeometry` object from the `rasters` package.
 
@@ -51,7 +51,7 @@ Calculates the day of the year for a given UTC time and an area defined by a `Ra
 **Returns:**
 - rasters.Raster: The day of the year.
 
-### `hour_of_day(time_UTC: datetime, geometry: rasters.RasterGeometry) -> rasters.Raster`
+### `solar_hour_of_day_for_area(time_UTC: datetime, geometry: rasters.RasterGeometry) -> rasters.Raster`
 
 Calculates the hour of the day for a given UTC time and an area defined by a `RasterGeometry` object from the `rasters` package.
 

pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools>=60", "setuptools-scm>=8.0", "wheel"]
 
 [project]
 name = "solar_apparent_time"
-version = "1.1.0"
+version = "1.2.0"
 description = "methods to translate Python datetime between solar apparent time and Coordinate Universal Time (UTC)"
 readme = "README.md"
 authors = [

solar_apparent_time/solar_apparent_time.py

@@ -28,7 +28,7 @@ def solar_to_UTC(time_solar: datetime, lon: float) -> datetime:
     """
     return time_solar - timedelta(hours=(np.radians(lon) / np.pi * 12))
 
-def UTC_offset_hours(geometry: rt.RasterGeometry) -> rt.Raster:
+def UTC_offset_hours_for_area(geometry: rt.RasterGeometry) -> rt.Raster:
     """
     Calculates the UTC offset in hours for a given raster geometry.
 
@@ -40,7 +40,7 @@ def UTC_offset_hours(geometry: rt.RasterGeometry) -> rt.Raster:
     """
     return rt.Raster(np.radians(geometry.lon) / np.pi * 12, geometry=geometry)
 
-def day_of_year(time_UTC: datetime, geometry: rt.RasterGeometry) -> rt.Raster:
+def solar_day_of_year_for_area(time_UTC: datetime, geometry: rt.RasterGeometry) -> rt.Raster:
     """
     Calculates the day of the year for a given UTC time and raster geometry.
 
@@ -53,15 +53,15 @@ def day_of_year(time_UTC: datetime, geometry: rt.RasterGeometry) -> rt.Raster:
     """
     doy_UTC = time_UTC.timetuple().tm_yday
     hour_UTC = time_UTC.hour + time_UTC.minute / 60 + time_UTC.second / 3600
-    UTC_offset_hours = UTC_offset_hours(geometry=geometry)
+    UTC_offset_hours = UTC_offset_hours_for_area(geometry=geometry)
     hour_of_day = hour_UTC + UTC_offset_hours
     doy = doy_UTC
     doy = rt.where(hour_of_day < 0, doy - 1, doy)
     doy = rt.where(hour_of_day > 24, doy + 1, doy)
 
     return doy
 
-def hour_of_day(time_UTC: datetime, geometry: rt.RasterGeometry) -> rt.Raster:
+def solar_hour_of_day_for_area(time_UTC: datetime, geometry: rt.RasterGeometry) -> rt.Raster:
     """
     Calculates the hour of the day for a given UTC time and raster geometry.
 
@@ -73,7 +73,7 @@ def hour_of_day(time_UTC: datetime, geometry: rt.RasterGeometry) -> rt.Raster:
     rt.Raster: The hour of the day.
     """
     hour_UTC = time_UTC.hour + time_UTC.minute / 60 + time_UTC.second / 3600
-    UTC_offset_hours = UTC_offset_hours(geometry=geometry)
+    UTC_offset_hours = UTC_offset_hours_for_area(geometry=geometry)
     hour_of_day = hour_UTC + UTC_offset_hours
     hour_of_day = rt.where(hour_of_day < 0, hour_of_day + 24, hour_of_day)
     hour_of_day = rt.where(hour_of_day > 24, hour_of_day - 24, hour_of_day)

solar_apparent_time/version.txt

@@ -1 +1 @@
-1.1.0
+1.2.0