Skip to content

Improved error handling and weather file documentation for v1 release#8

Merged
javlor merged 12 commits intomainfrom
bugfix/error_handling
Apr 7, 2026
Merged

Improved error handling and weather file documentation for v1 release#8
javlor merged 12 commits intomainfrom
bugfix/error_handling

Conversation

@iantsednv
Copy link
Copy Markdown
Collaborator

Error Handling

  • Raise SolarFarmerAPIError on API failures instead of returning None — exception includes status code, message, and full error details
  • Fix type annotation bugs in Response.problem_details_json and _log_api_failure

Documentation Fixes

  • Fix gridConnectionLimit units (Watts, not MW)
  • Document spec ID ↔ filename stem convention for PAN/OND files
  • Document bifacial mounting requirements and rack height constraints
  • Add comprehensive calculationYear + TMY timestamp interaction docs (warns about silent partial-year calculations)

Weather File Spec

  • Add solarfarmer.weather.TSV_COLUMNS — machine-readable TSV format spec with all accepted header aliases, units, ranges, and sentinel values
  • Enrich MeteoFileFormat enum with per-value docstrings and inline TSV example
  • Cross-reference weather-dependent EnergyCalculationOptions fields

@javlor javlor merged commit 4f13c6e into main Apr 7, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants