tyba-client 0.3.7__py3-none-any.whl → 0.4.1__py3-none-any.whl

tyba_client/__init__.py

@@ -1 +1 @@
-__version__ = "0.3.1"
+__version__ = "0.4.0"

tyba_client/forecast.py

@@ -12,12 +12,15 @@ class Forecast(object):
         return response.json()
 
     def most_recent(
-        self,
-        object_name: str,
-        product: str,
-        start_time: datetime,
-        end_time: datetime,
-        forecast_type=None,
+            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",
@@ -27,17 +30,24 @@ class Forecast(object):
                 "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,
+            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",
@@ -48,19 +58,25 @@ class Forecast(object):
                 "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,
+            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",
@@ -73,20 +89,26 @@ class Forecast(object):
                 "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,
+            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",
@@ -100,16 +122,22 @@ class Forecast(object):
                 "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,
+            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",
@@ -119,17 +147,23 @@ class Forecast(object):
                 "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,
+            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",
@@ -140,11 +174,14 @@ class Forecast(object):
                 "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
+            self, object_name: str, product: str, start_time: datetime, end_time: datetime
     ):
         return self.get(
             "actuals",

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/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/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.dist-info → tyba_client-0.4.1.dist-info}/METADATA

@@ -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.4.1.dist-info/RECORD

@@ -0,0 +1,12 @@
+LICENSE,sha256=LbMfEdjEK-IRzvCfdEBhn9UCANze0Rc7hWrQTEj_xvU,1079
+tyba_client/__init__.py,sha256=42STGor_9nKYXumfeV5tiyD_M8VdcddX7CEexmibPBk,22
+tyba_client/client.py,sha256=zEqlK-w4T02u8VKatIeJuBY8xDcDlTfko_9yJvBT64c,5761
+tyba_client/forecast.py,sha256=lhzTewXZNqxOmuNuBmjw_NnikObqJSSu-yLFt7qSBSM,6377
+tyba_client/io.py,sha256=iyiQrpM1xg9XAoXlU6JvNB1uxRK77keJ8gAG-fefV2U,5783
+tyba_client/models.py,sha256=_ZhMOwbEknOhwyjrpedUT1r7r7J92-AAqkpGbZJaEVQ,17525
+tyba_client/solar_resource.py,sha256=oUD6-qUJhiIjrHbSzSL0X4asGgU4lRBocyy0MkA3keY,3379
+tyba_client/utils.py,sha256=n4tUBGlQIwxbLqJcQRiAIbIJA0DaLSjbAxakhukqaeE,876
+tyba_client-0.4.1.dist-info/LICENSE,sha256=LbMfEdjEK-IRzvCfdEBhn9UCANze0Rc7hWrQTEj_xvU,1079
+tyba_client-0.4.1.dist-info/METADATA,sha256=tARY9izCghh03klzoix8JNoKdSTwDqSllwIuayLZ6Ec,2292
+tyba_client-0.4.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+tyba_client-0.4.1.dist-info/RECORD,,

tyba_client-0.3.7.dist-info/RECORD

@@ -1,11 +0,0 @@
-LICENSE,sha256=LbMfEdjEK-IRzvCfdEBhn9UCANze0Rc7hWrQTEj_xvU,1079
-tyba_client/__init__.py,sha256=r4xAFihOf72W9TD-lpMi6ntWSTKTP2SlzKP1ytkjRbI,22
-tyba_client/client.py,sha256=zEqlK-w4T02u8VKatIeJuBY8xDcDlTfko_9yJvBT64c,5761
-tyba_client/forecast.py,sha256=Cd9HD7ZtwkJf86V_nGMP1dcSr_LEKMWrcAfbL1htJfg,4428
-tyba_client/io.py,sha256=jT2V6UaLTFiH4gi0Luo80jO9abV86qsVa_LQfD99LSo,7015
-tyba_client/models.py,sha256=J17fQKIMGV1BDBleJutyJkTvk_sqIiqU-9OHd6kV58A,17498
-tyba_client/utils.py,sha256=n4tUBGlQIwxbLqJcQRiAIbIJA0DaLSjbAxakhukqaeE,876
-tyba_client-0.3.7.dist-info/LICENSE,sha256=LbMfEdjEK-IRzvCfdEBhn9UCANze0Rc7hWrQTEj_xvU,1079
-tyba_client-0.3.7.dist-info/METADATA,sha256=U99PYV7_YfY0xWnmu-h64765r5SV-MLjOlAkteG1H10,2308
-tyba_client-0.3.7.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-tyba_client-0.3.7.dist-info/RECORD,,