tyba-client 0.3.7__tar.gz → 0.4.1__tar.gz

{tyba_client-0.3.7 → tyba_client-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tyba-client
-Version: 0.3.7
+Version: 0.4.1
 Summary: A Python API client for the Tyba Public API
 License: MIT
 Author: Tyler Nisonoff
@@ -13,13 +13,13 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: dataclasses-json (>=0.5.4,<0.6.0)
-Requires-Dist: generation-models (>=0.4.1,<0.5.0)
+Requires-Dist: dataclasses-json (>=0.6.4,<0.7.0)
+Requires-Dist: generation-models (>=0,<1)
 Requires-Dist: marshmallow (>=3.12.1,<4.0.0)
 Requires-Dist: pandas (>=1.3.2,<2.0.0)
 Requires-Dist: requests (>=2.25.1,<3.0.0)
-Requires-Dist: structlog (>=23.1.0,<24.0.0)
-Requires-Dist: tyba-financial-model (>=0.1.0,<0.2.0)
+Requires-Dist: structlog (>=24.1.0,<25.0.0)
+Requires-Dist: tyba-financial-model (>=0,<1)
 Description-Content-Type: text/markdown
 
 # Tyba API Client

{tyba_client-0.3.7 → tyba_client-0.4.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "tyba-client"
-version = "0.3.7"
+version = "0.4.1"
 description = "A Python API client for the Tyba Public API"
 authors = ["Tyler Nisonoff <tyler@tybaenergy.com>"]
 license = "MIT"
@@ -12,15 +12,15 @@ include = [
 [tool.poetry.dependencies]
 python = "^3.8"
 requests = "^2.25.1"
-dataclasses-json = "^0.5.4"
+dataclasses-json = "^0.6.4"
 marshmallow = "^3.12.1"
 pandas = "^1.3.2"
-tyba-financial-model = "^0.1.0"
-structlog = "^23.1.0"
-generation-models = "^0.4.1"
+tyba-financial-model = "^0"
+structlog = "^24.1.0"
+generation-models = "^0"
 
 [tool.poetry.group.dev.dependencies]
-pytest = "^5.2"
+pytest = "^8.1.1"
 ipython = "^7.29.0"
 ipdb = "^0.13.9"
 sphinx = "^7.0.1"

tyba_client-0.4.1/tyba_client/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.4.0"

tyba_client-0.4.1/tyba_client/forecast.py

@@ -0,0 +1,194 @@
+from datetime import datetime, time
+from typing import List
+
+
+class Forecast(object):
+    def __init__(self, client):
+        self.client = client
+
+    def get(self, route, params=None):
+        response = self.client.get(f"forecasts/{route}", params=params)
+        response.raise_for_status()
+        return response.json()
+
+    def most_recent(
+            self,
+            object_name: str,
+            product: str,
+            start_time: datetime,
+            end_time: datetime,
+            forecast_type=None,
+            predictions_per_hour=None,
+            prediction_lead_time_mins=None,
+            horizon_mins=None,
+    ):
+        return self.get(
+            "most_recent_forecast",
+            params={
+                "object_name": object_name,
+                "product": product,
+                "start_time": start_time,
+                "end_time": end_time,
+                "forecast_type": forecast_type,
+                "predictions_per_hour": predictions_per_hour,
+                "prediction_lead_time_mins": prediction_lead_time_mins,
+                "horizon_mins": horizon_mins,
+            },
+        )
+
+    def most_recent_probabilistic(
+            self,
+            object_name: str,
+            product: str,
+            start_time: datetime,
+            end_time: datetime,
+            quantiles: List[float],
+            forecast_type=None,
+            predictions_per_hour=None,
+            prediction_lead_time_mins=None,
+            horizon_mins=None,
+
+    ):
+        return self.get(
+            "most_recent_probabilistic_forecast",
+            params={
+                "object_name": object_name,
+                "product": product,
+                "start_time": start_time,
+                "end_time": end_time,
+                "quantiles": quantiles,
+                "forecast_type": forecast_type,
+                "predictions_per_hour": predictions_per_hour,
+                "prediction_lead_time_mins": prediction_lead_time_mins,
+                "horizon_mins": horizon_mins,
+            },
+        )
+
+    def vintaged(
+            self,
+            object_name: str,
+            product: str,
+            start_time: datetime,
+            end_time: datetime,
+            days_ago: int,
+            before_time: time,
+            exact_vintage: bool = False,
+            forecast_type=None,
+            predictions_per_hour=None,
+            prediction_lead_time_mins=None,
+            horizon_mins=None,
+    ):
+        return self.get(
+            "vintaged_forecast",
+            params={
+                "object_name": object_name,
+                "product": product,
+                "start_time": start_time,
+                "end_time": end_time,
+                "days_ago": days_ago,
+                "before_time": before_time,
+                "exact_vintage": exact_vintage,
+                "forecast_type": forecast_type,
+                "predictions_per_hour": predictions_per_hour,
+                "prediction_lead_time_mins": prediction_lead_time_mins,
+                "horizon_mins": horizon_mins,
+            },
+        )
+
+    def vintaged_probabilistic(
+            self,
+            object_name: str,
+            product: str,
+            start_time: datetime,
+            end_time: datetime,
+            quantiles: List[float],
+            days_ago: int,
+            before_time: time,
+            exact_vintage: bool = False,
+            forecast_type=None,
+            predictions_per_hour=None,
+            prediction_lead_time_mins=None,
+            horizon_mins=None,
+    ):
+        return self.get(
+            "vintaged_probabilistic_forecast",
+            params={
+                "object_name": object_name,
+                "product": product,
+                "start_time": start_time,
+                "end_time": end_time,
+                "quantiles": quantiles,
+                "days_ago": days_ago,
+                "before_time": before_time,
+                "exact_vintage": exact_vintage,
+                "forecast_type": forecast_type,
+                "predictions_per_hour": predictions_per_hour,
+                "prediction_lead_time_mins": prediction_lead_time_mins,
+                "horizon_mins": horizon_mins,
+            },
+        )
+
+    def by_vintage(
+            self,
+            object_name: str,
+            product: str,
+            vintage_start_time: datetime,
+            vintage_end_time: datetime,
+            forecast_type=None,
+            predictions_per_hour=None,
+            prediction_lead_time_mins=None,
+            horizon_mins=None,
+    ):
+        return self.get(
+            "forecasts_by_vintage",
+            params={
+                "object_name": object_name,
+                "product": product,
+                "start_time": vintage_start_time,
+                "end_time": vintage_end_time,
+                "forecast_type": forecast_type,
+                "predictions_per_hour": predictions_per_hour,
+                "prediction_lead_time_mins": prediction_lead_time_mins,
+                "horizon_mins": horizon_mins,
+            },
+        )
+
+    def by_vintage_probabilistic(
+            self,
+            object_name: str,
+            product: str,
+            quantiles: List[float],
+            vintage_start_time: datetime,
+            vintage_end_time: datetime,
+            forecast_type=None,
+            predictions_per_hour=None,
+            prediction_lead_time_mins=None,
+            horizon_mins=None,
+    ):
+        return self.get(
+            "probabilistic_forecasts_by_vintage",
+            params={
+                "object_name": object_name,
+                "product": product,
+                "quantiles": quantiles,
+                "start_time": vintage_start_time,
+                "end_time": vintage_end_time,
+                "forecast_type": forecast_type,
+                "predictions_per_hour": predictions_per_hour,
+                "prediction_lead_time_mins": prediction_lead_time_mins,
+                "horizon_mins": horizon_mins,
+            },
+        )
+
+    def actuals(
+            self, object_name: str, product: str, start_time: datetime, end_time: datetime
+    ):
+        return self.get(
+            "actuals",
+            params={
+                "object_name": object_name,
+                "product": product,
+                "start_time": start_time,
+                "end_time": end_time,
+            },
+        )

{tyba_client-0.3.7 → tyba_client-0.4.1}/tyba_client/io.py

@@ -4,11 +4,7 @@ from generation_models import (
     ONDInverter,
     ONDEfficiencyCurve,
     ONDTemperatureDerateCurve,
-    SolarResource,
-    SolarResourceTimeSeries,
 )
-import pandas as pd
-import typing as t
 
 
 def read_pvsyst_file(path: str) -> dict:
@@ -160,48 +156,3 @@ def inverter_from_ond(ond_file: str, includes_xfmr: bool = True) -> ONDInverter:
         aux_loss_threshold=aux_loss_threshold,
         includes_xfmr=includes_xfmr,
     )
-
-
-psm_column_map = {
-    "Year": "year",
-    "Month": "month",
-    "Day": "day",
-    "Hour": "hour",
-    "Minute": "minute",
-    "GHI": "gh",
-    "DNI": "dn",
-    "DHI": "df",
-    "POA": "poa",
-    "Temperature": "tdry",
-    # twet
-    "Dew Point": "tdew",
-    "Relative Humidity": "rhum",
-    "Pressure": "pres",
-    # Snow
-    "Surface Albedo": "alb",
-    # aod
-    "Wind Speed": "wspd",
-    "Wind Direction": "wdir",
-}
-
-
-def solar_resource_from_psm_csv(
-    filename: str,
-    typical: bool = True,
-    monthly_albedo: t.Optional[t.List[float]] = None,
-) -> SolarResource:
-    """_"""
-    with open(filename) as f:
-        _meta = [f.readline().split(",") for _ in range(2)]
-        _data = pd.read_csv(f)
-    meta = {k: v for k, v in zip(*_meta)}
-    data = _data.rename(columns=psm_column_map)
-    return SolarResource(
-        latitude=float(meta["Latitude"]),
-        longitude=float(meta["Longitude"]),
-        elevation=float(meta["Elevation"]),
-        time_zone_offset=float(meta["Time Zone"]),
-        data=SolarResourceTimeSeries(**data.to_dict(orient="list")),
-        monthly_albedo=monthly_albedo,
-        typical=typical,
-    )

{tyba_client-0.3.7 → tyba_client-0.4.1}/tyba_client/models.py

@@ -4,7 +4,8 @@ from enum import Enum
 from dataclasses_json import config, dataclass_json
 import pandas as pd
 import typing as t
-from .io import read_pvsyst_file, psm_column_map
+from .io import read_pvsyst_file
+from .solar_resource import psm_column_map
 
 from tyba_client.utils import string_enum
 

tyba_client-0.4.1/tyba_client/solar_resource.py

@@ -0,0 +1,117 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+import pandas as pd
+import requests
+from generation_models import SolarResource, SolarResourceTimeSeries
+from requests.exceptions import HTTPError
+import typing as t
+from io import StringIO
+
+
+@dataclass
+class PSMClient:
+    api_key: str
+    email: str
+
+    def _get_solar_resource(
+        self,
+        source: str,
+        latitude: float,
+        longitude: float,
+        year: t.Union[str, int],
+        utc: bool,
+    ):
+        resp = requests.get(
+            url=f"https://developer.nrel.gov/api/nsrdb/v2/solar/{source}.csv",
+            params={
+                "api_key": self.api_key,
+                "email": self.email,
+                "wkt": f"POINT({longitude} {latitude})",
+                "names": year,
+                "utc": "true" if utc else "false",
+            },
+        )
+        if resp.status_code == 400:
+            raise HTTPError(resp.json()["errors"])
+        resp.raise_for_status()
+        return resp.text
+
+    @staticmethod
+    def _process_csv(raw: str) -> SolarResource:
+        with StringIO(raw) as f:
+            _meta = [f.readline().split(",") for _ in range(2)]
+            _data = pd.read_csv(f)
+        meta = {k: v for k, v in zip(*_meta)}
+        data = _data.rename(columns=psm_column_map)
+        return SolarResource(
+            latitude=float(meta["Latitude"]),
+            longitude=float(meta["Longitude"]),
+            elevation=float(meta["Elevation"]),
+            time_zone_offset=float(meta["Time Zone"]),
+            data=SolarResourceTimeSeries(**data.to_dict(orient="list")),
+        )
+
+    def get_historical(
+        self,
+        latitude: float,
+        longitude: float,
+        year: int,
+        utc: bool = False,
+    ) -> SolarResource:
+        raw = self._get_solar_resource(source="psm3-2-2-download", latitude=latitude, longitude=longitude, year=year, utc=utc)
+        return self._process_csv(raw)
+
+    def get_typical(
+        self,
+        latitude: float,
+        longitude: float,
+        year: str = "tgy-2022",
+        utc: bool = False,
+    ) -> SolarResource:
+        raw = self._get_solar_resource(source="psm3-2-2-tmy-download", latitude=latitude, longitude=longitude, year=year, utc=utc)
+        return self._process_csv(raw)
+
+
+def solar_resource_from_psm_csv(
+    filename: str,
+    monthly_albedo: t.Optional[t.List[float]] = None,
+) -> SolarResource:
+    """_"""
+    with open(filename) as f:
+        _meta = [f.readline().split(",") for _ in range(2)]
+        _data = pd.read_csv(f)
+    meta = {k: v for k, v in zip(*_meta)}
+    data = _data.rename(columns=psm_column_map)
+    return SolarResource(
+        latitude=float(meta["Latitude"]),
+        longitude=float(meta["Longitude"]),
+        elevation=float(meta["Elevation"]),
+        time_zone_offset=float(meta["Time Zone"]),
+        data=SolarResourceTimeSeries(**data.to_dict(orient="list")),
+        monthly_albedo=monthly_albedo,
+    )
+
+
+psm_column_map = {
+    "Year": "year",
+    "Month": "month",
+    "Day": "day",
+    "Hour": "hour",
+    "Minute": "minute",
+    "GHI": "gh",
+    "DNI": "dn",
+    "DHI": "df",
+    "POA": "poa",
+    "Temperature": "tdry",
+    # twet
+    "Dew Point": "tdew",
+    "Relative Humidity": "rhum",
+    "Pressure": "pres",
+    # Snow
+    "Surface Albedo": "alb",
+    # aod
+    "Wind Speed": "wspd",
+    "Wind Direction": "wdir",
+}

tyba_client-0.3.7/tyba_client/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.3.1"

tyba_client-0.3.7/tyba_client/forecast.py

@@ -1,157 +0,0 @@
-from datetime import datetime, time
-from typing import List
-
-
-class Forecast(object):
-    def __init__(self, client):
-        self.client = client
-
-    def get(self, route, params=None):
-        response = self.client.get(f"forecasts/{route}", params=params)
-        response.raise_for_status()
-        return response.json()
-
-    def most_recent(
-        self,
-        object_name: str,
-        product: str,
-        start_time: datetime,
-        end_time: datetime,
-        forecast_type=None,
-    ):
-        return self.get(
-            "most_recent_forecast",
-            params={
-                "object_name": object_name,
-                "product": product,
-                "start_time": start_time,
-                "end_time": end_time,
-                "forecast_type": forecast_type,
-            },
-        )
-
-    def most_recent_probabilistic(
-        self,
-        object_name: str,
-        product: str,
-        start_time: datetime,
-        end_time: datetime,
-        quantiles: List[float],
-        forecast_type=None,
-    ):
-        return self.get(
-            "most_recent_probabilistic_forecast",
-            params={
-                "object_name": object_name,
-                "product": product,
-                "start_time": start_time,
-                "end_time": end_time,
-                "quantiles": quantiles,
-                "forecast_type": forecast_type,
-            },
-        )
-
-    def vintaged(
-        self,
-        object_name: str,
-        product: str,
-        start_time: datetime,
-        end_time: datetime,
-        days_ago: int,
-        before_time: time,
-        exact_vintage: bool = False,
-        forecast_type=None,
-    ):
-        return self.get(
-            "vintaged_forecast",
-            params={
-                "object_name": object_name,
-                "product": product,
-                "start_time": start_time,
-                "end_time": end_time,
-                "days_ago": days_ago,
-                "before_time": before_time,
-                "exact_vintage": exact_vintage,
-                "forecast_type": forecast_type,
-            },
-        )
-
-    def vintaged_probabilistic(
-        self,
-        object_name: str,
-        product: str,
-        start_time: datetime,
-        end_time: datetime,
-        quantiles: List[float],
-        days_ago: int,
-        before_time: time,
-        exact_vintage: bool = False,
-        forecast_type=None,
-    ):
-        return self.get(
-            "vintaged_probabilistic_forecast",
-            params={
-                "object_name": object_name,
-                "product": product,
-                "start_time": start_time,
-                "end_time": end_time,
-                "quantiles": quantiles,
-                "days_ago": days_ago,
-                "before_time": before_time,
-                "exact_vintage": exact_vintage,
-                "forecast_type": forecast_type,
-            },
-        )
-
-    def by_vintage(
-        self,
-        object_name: str,
-        product: str,
-        vintage_start_time: datetime,
-        vintage_end_time: datetime,
-        forecast_type=None,
-    ):
-        return self.get(
-            "forecasts_by_vintage",
-            params={
-                "object_name": object_name,
-                "product": product,
-                "start_time": vintage_start_time,
-                "end_time": vintage_end_time,
-                "forecast_type": forecast_type,
-            },
-        )
-
-    def by_vintage_probabilistic(
-        self,
-        object_name: str,
-        product: str,
-        quantiles: List[float],
-        vintage_start_time: datetime,
-        vintage_end_time: datetime,
-        forecast_type=None,
-    ):
-        return self.get(
-            "probabilistic_forecasts_by_vintage",
-            params={
-                "object_name": object_name,
-                "product": product,
-                "quantiles": quantiles,
-                "start_time": vintage_start_time,
-                "end_time": vintage_end_time,
-                "forecast_type": forecast_type,
-            },
-        )
-
-    def actuals(
-        self, object_name: str, product: str, start_time: datetime, end_time: datetime
-    ):
-        return self.get(
-            "actuals",
-            params={
-                "object_name": object_name,
-                "product": product,
-                "start_time": start_time,
-                "end_time": end_time,
-            },
-        )