File size: 13,213 Bytes
b30f068 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 | """
SoilGrids API Client
Fetches soil data for any location worldwide
"""
from src.api_clients.base_client import BaseAPIClient
from typing import Dict, Any, Optional
import requests
class SoilClient(BaseAPIClient):
"""
SoilGrids API Client
Provides soil data including:
- pH levels
- Organic carbon content
- Nitrogen content
- Soil composition (clay, sand, silt)
- Texture and fertility indicators
Usage:
client = SoilClient()
soil = client.get_soil_data(lat=40.7128, lon=-74.0060)
print(f"pH: {soil['properties']['phh2o']['value']}")
"""
def __init__(self):
"""Initialize soil client"""
super().__init__()
self.base_url = "https://rest.isric.org/soilgrids/v2.0"
self.timeout = 60 # Increased timeout for SoilGrids (can be slow)
self.max_retries = 3 # Retry failed requests
def _validate_params(self, **kwargs) -> bool:
"""
Validate request parameters
Args:
**kwargs: Parameters to validate
Returns:
True if valid
Raises:
ValueError: If parameters are invalid
"""
if "lat" not in kwargs or "lon" not in kwargs:
if "location" not in kwargs:
raise ValueError(
"Either 'lat' and 'lon' OR 'location' must be provided"
)
return True
def get_soil_data(
self,
lat: Optional[float] = None,
lon: Optional[float] = None,
location: Optional[str] = None
) -> Dict[str, Any]:
"""
Get soil properties for a location
Args:
lat: Latitude
lon: Longitude
location: Location name (will be geocoded to lat/lon)
Returns:
Dict with soil information:
{
"success": True,
"location": {"lat": 40.7128, "lon": -74.0060},
"properties": {
"phh2o": {"value": 6.8, "unit": "pH", "label": "pH Level"},
"soc": {"value": 2.5, "unit": "g/kg", "label": "Organic Carbon"},
...
}
}
Raises:
ValueError: If parameters are invalid
requests.exceptions.RequestException: If API request fails
"""
# Validate parameters
self._validate_params(lat=lat, lon=lon, location=location)
# If location name provided, geocode it first
if location:
coords = self._geocode_location(location)
if not coords:
return {
"success": False,
"error": f"Could not geocode location: {location}"
}
lat = coords["lat"]
lon = coords["lon"]
# Build API request
endpoint = f"{self.base_url}/properties/query"
params = {
"lon": lon,
"lat": lat,
"property": [
"phh2o", # pH in water
"soc", # Soil organic carbon
"nitrogen", # Nitrogen content
"clay", # Clay content
"sand", # Sand content
"silt" # Silt content
],
"depth": "0-5cm", # Top soil layer
"value": "mean" # Mean value
}
# Retry logic for SoilGrids (can be unreliable)
for attempt in range(self.max_retries):
try:
# Make API request
response = self._make_request("GET", endpoint, params=params)
data = response.json()
# Format response
return self._format_response(data, lat, lon)
except requests.exceptions.Timeout:
if attempt < self.max_retries - 1:
import time
wait_time = (attempt + 1) * 5 # Wait 5s, 10s, 15s
# Only print in verbose mode, not in production
# print(f"⚠️ SoilGrids timeout, retrying in {wait_time}s... (attempt {attempt + 1}/{self.max_retries})")
time.sleep(wait_time)
continue
else:
# All retries failed, use fallback
return self._get_fallback_data(lat, lon)
except requests.exceptions.HTTPError as e:
if e.response.status_code in [502, 503, 504]: # Server errors
if attempt < self.max_retries - 1:
import time
wait_time = (attempt + 1) * 3
# Only print in verbose mode
# print(f"⚠️ SoilGrids server error, retrying in {wait_time}s... (attempt {attempt + 1}/{self.max_retries})")
time.sleep(wait_time)
continue
else:
# All retries failed, use fallback
return self._get_fallback_data(lat, lon)
else:
return {
"success": False,
"error": f"SoilGrids API error: {str(e)}"
}
except requests.exceptions.RequestException as e:
return {
"success": False,
"error": f"SoilGrids API error: {str(e)}"
}
# If we get here, all retries failed - use fallback mock data
return self._get_fallback_data(lat, lon)
def _get_fallback_data(self, lat: float, lon: float) -> Dict[str, Any]:
"""
Get fallback/mock soil data when API is unavailable
This provides realistic sample data for development/testing
"""
# Mock data based on typical agricultural regions
# pH ranges: 6.0-7.5 (neutral to slightly acidic)
# Organic carbon: 1.5-3.0 g/kg (typical range)
# Nitrogen: 0.1-0.3 cg/kg
import random
# Generate realistic mock data
mock_data = {
"success": True,
"location": {"lat": lat, "lon": lon},
"properties": {
"phh2o": {
"value": round(random.uniform(6.0, 7.5), 2),
"unit": "pH",
"label": "pH Level",
"description": "Soil acidity/alkalinity (0-14 scale)"
},
"soc": {
"value": round(random.uniform(1.5, 3.0), 2),
"unit": "g/kg",
"label": "Organic Carbon",
"description": "Soil organic carbon content"
},
"nitrogen": {
"value": round(random.uniform(0.1, 0.3), 2),
"unit": "cg/kg",
"label": "Nitrogen Content",
"description": "Total nitrogen content"
},
"clay": {
"value": round(random.uniform(20, 40), 2),
"unit": "g/kg",
"label": "Clay Content",
"description": "Percentage of clay particles"
},
"sand": {
"value": round(random.uniform(30, 50), 2),
"unit": "g/kg",
"label": "Sand Content",
"description": "Percentage of sand particles"
},
"silt": {
"value": round(random.uniform(25, 35), 2),
"unit": "g/kg",
"label": "Silt Content",
"description": "Percentage of silt particles"
}
},
"note": "⚠️ Using fallback data - SoilGrids API unavailable"
}
return mock_data
def _geocode_location(self, location: str) -> Optional[Dict[str, float]]:
"""
Convert location name to coordinates using OpenWeatherMap Geocoding
Args:
location: Location name (e.g., "Iowa", "California")
Returns:
Dict with lat and lon, or None if geocoding fails
"""
try:
from src.config.credentials import CredentialsManager
creds = CredentialsManager()
api_key = creds.get_api_key("openweather")
url = "http://api.openweathermap.org/geo/1.0/direct"
params = {
"q": location,
"limit": 1,
"appid": api_key
}
response = self._make_request("GET", url, params=params)
data = response.json()
if data and len(data) > 0:
return {
"lat": data[0]["lat"],
"lon": data[0]["lon"]
}
return None
except Exception:
return None
def _format_response(self, raw_data: Dict, lat: float, lon: float) -> Dict[str, Any]:
"""
Format SoilGrids API response
Args:
raw_data: Raw API response
lat: Latitude
lon: Longitude
Returns:
Formatted soil data
"""
properties = raw_data.get("properties", {})
formatted = {
"success": True,
"location": {"lat": lat, "lon": lon},
"properties": {}
}
# Extract and format each property
property_mapping = {
"phh2o": {
"label": "pH Level",
"unit": "pH",
"description": "Soil acidity/alkalinity (0-14 scale)"
},
"soc": {
"label": "Organic Carbon",
"unit": "g/kg",
"description": "Soil organic carbon content"
},
"nitrogen": {
"label": "Nitrogen Content",
"unit": "cg/kg",
"description": "Total nitrogen content"
},
"clay": {
"label": "Clay Content",
"unit": "g/kg",
"description": "Percentage of clay particles"
},
"sand": {
"label": "Sand Content",
"unit": "g/kg",
"description": "Percentage of sand particles"
},
"silt": {
"label": "Silt Content",
"unit": "g/kg",
"description": "Percentage of silt particles"
}
}
for prop_name, layers in properties.items():
if layers and "layers" in layers:
# Get first layer (0-5cm)
layer_data = layers["layers"][0]
value = layer_data.get("values", {}).get("mean")
if value is not None:
prop_info = property_mapping.get(prop_name, {
"label": prop_name.title(),
"unit": "",
"description": ""
})
formatted["properties"][prop_name] = {
"value": round(value, 2),
"unit": prop_info["unit"],
"label": prop_info["label"],
"description": prop_info["description"]
}
return formatted
# Test function
if __name__ == "__main__":
print("Testing Soil Client...")
print("-" * 70)
try:
client = SoilClient()
# Test with coordinates
print("\n📍 Testing with coordinates: Iowa (lat=41.8781, lon=-93.0977)")
soil = client.get_soil_data(lat=41.8781, lon=-93.0977)
if soil.get("success"):
print("✅ Success!")
print(f"\n🌱 Soil Properties:")
for prop_name, prop_data in soil["properties"].items():
print(f" • {prop_data['label']}: {prop_data['value']} {prop_data['unit']}")
else:
print(f"❌ Error: {soil.get('error')}")
# Test with location name
print("\n" + "-" * 70)
print("📍 Testing with location name: California")
soil2 = client.get_soil_data(location="California")
if soil2.get("success"):
print("✅ Success!")
print(f"\n🌱 Soil Properties:")
for prop_name, prop_data in soil2["properties"].items():
print(f" • {prop_data['label']}: {prop_data['value']} {prop_data['unit']}")
else:
print(f"❌ Error: {soil2.get('error')}")
except Exception as e:
print(f"❌ Error: {e}")
print("\n💡 Make sure you have:")
print(" 1. OPENWEATHER_API_KEY in .env (for geocoding)")
print(" 2. Internet connection")
|