tyba-client 0.2.3__tar.gz → 0.2.4__tar.gz

tyba_client-0.2.4/PKG-INFO

@@ -0,0 +1,56 @@
+Metadata-Version: 2.1
+Name: tyba-client
+Version: 0.2.4
+Summary: A Python API client for the Tyba Public API
+License: MIT
+Author: Tyler Nisonoff
+Author-email: tyler@tybaenergy.com
+Requires-Python: >=3.8,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: dataclasses-json (>=0.5.4,<0.6.0)
+Requires-Dist: generation-models (>=0.3.0,<0.4.0)
+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)
+Description-Content-Type: text/markdown
+
+# Tyba API Client
+
+## Examples
+For examples see [https://github.com/Tyba-Energy/tyba-client-notebooks](https://github.com/Tyba-Energy/tyba-client-notebooks).
+The script examples in tyba-python-client/examples will be deprecated eventually.
+
+## Development
+### Docs
+We use [`sphinx`](https://github.com/sphinx-doc/sphinx) and
+[`autodoc-pydantic`](https://github.com/mansenfranzen/autodoc_pydantic) to manage the documentation for the client.
+Source .rst files can be found in docs/source.
+
+To generate/update documentation for the Tyba client, first make sure
+your poetry environment includes the latest versions of all the dependency packages included in the docs. For example,
+if `generation-models` was recently updated and pushed to pypi, you should run `poetry update` (or if you are concerned
+about changing other packages, just `poetry add generation-models==x.x.x` where `x.x.x` is the latest version).
+Then, `cd` into the docs directory and run the makefile that generates the HTML documentation
+```bash
+# Assuming you are already in the tyba-python-client directory
+$ cd docs
+$ poetry run make html
+```
+The HTML documentation can be found in docs/build/html.
+
+This HTML documentation now needs to be uploaded to s3, so it
+can be served at [https://docs.tybaenergy.com/api/](https://docs.tybaenergy.com/api/). We have a python script to do this
+```bash
+poetry run python docs/upload_to_s3.py
+```
+
+
+
+

tyba_client-0.2.4/README.md

@@ -0,0 +1,32 @@
+# Tyba API Client
+
+## Examples
+For examples see [https://github.com/Tyba-Energy/tyba-client-notebooks](https://github.com/Tyba-Energy/tyba-client-notebooks).
+The script examples in tyba-python-client/examples will be deprecated eventually.
+
+## Development
+### Docs
+We use [`sphinx`](https://github.com/sphinx-doc/sphinx) and
+[`autodoc-pydantic`](https://github.com/mansenfranzen/autodoc_pydantic) to manage the documentation for the client.
+Source .rst files can be found in docs/source.
+
+To generate/update documentation for the Tyba client, first make sure
+your poetry environment includes the latest versions of all the dependency packages included in the docs. For example,
+if `generation-models` was recently updated and pushed to pypi, you should run `poetry update` (or if you are concerned
+about changing other packages, just `poetry add generation-models==x.x.x` where `x.x.x` is the latest version).
+Then, `cd` into the docs directory and run the makefile that generates the HTML documentation
+```bash
+# Assuming you are already in the tyba-python-client directory
+$ cd docs
+$ poetry run make html
+```
+The HTML documentation can be found in docs/build/html.
+
+This HTML documentation now needs to be uploaded to s3, so it
+can be served at [https://docs.tybaenergy.com/api/](https://docs.tybaenergy.com/api/). We have a python script to do this
+```bash
+poetry run python docs/upload_to_s3.py
+```
+
+
+

{tyba_client-0.2.3 → tyba_client-0.2.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "tyba-client"
-version = "0.2.3"
+version = "0.2.4"
 description = "A Python API client for the Tyba Public API"
 authors = ["Tyler Nisonoff <tyler@tybaenergy.com>"]
 license = "MIT"
@@ -16,13 +16,17 @@ dataclasses-json = "^0.5.4"
 marshmallow = "^3.12.1"
 pandas = "^1.3.2"
 tyba-financial-model = "^0.1.0"
-generation-models = "^0.2.0"
+generation-models = "^0.3.0"
 structlog = "^23.1.0"
 
-[tool.poetry.dev-dependencies]
+[tool.poetry.group.dev.dependencies]
 pytest = "^5.2"
 ipython = "^7.29.0"
 ipdb = "^0.13.9"
+sphinx = "^7.0.1"
+autodoc-pydantic = "^1.8.0"
+sphinx-material = {git = "https://github.com/bashtage/sphinx-material.git"}
+boto3 = "^1.28.22"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

{tyba_client-0.2.3 → tyba_client-0.2.4}/tyba_client/client.py

@@ -13,6 +13,9 @@ logger = get_logger()
 
 
 class Ancillary(object):
+    """
+
+    """
     def __init__(self, prices):
         self.prices = prices
 
@@ -34,6 +37,9 @@ class Ancillary(object):
 
 
 class LMP(object):
+    """
+
+    """
     def __init__(self, prices):
         self.prices = prices
 
@@ -51,6 +57,9 @@ class LMP(object):
 
 
 class Services(object):
+    """
+
+    """
     def __init__(self, client):
         self.client = client
         self.ancillary = Ancillary(self)
@@ -64,7 +73,7 @@ class Services(object):
 
 
 class Client(object):
-    """Tyba client class"""
+    """Tyba valuation client class"""
 
     DEFAULT_OPTIONS = {
         'version': '0.1'

tyba_client-0.2.4/tyba_client/io.py

@@ -0,0 +1,166 @@
+from __future__ import annotations
+from generation_models import PVModuleMermoudLejeune, ONDInverter, ONDEfficiencyCurve, ONDTemperatureDerateCurve, SolarResource, SolarResourceTimeSeries
+import pandas as pd
+import typing as t
+
+
+def read_pvsyst_file(path: str) -> dict:
+    try:
+        with open(path, "r", encoding="utf-8-sig") as f:
+            blob = {}
+            trace = [blob]
+            lines = [line for line in f.readlines() if "=" in line]
+            indentations = [len(line) - len(line.lstrip()) for line in lines]
+            for indentation, line in zip(indentations, lines):
+                if divmod(indentation, 2)[1] != 0:
+                    raise PVSystFileError(f"invalid indentation at {line}")
+            structure = [(y - x) // 2 for x, y in zip(indentations[:-1], indentations[1:])]
+            structure.append(0)
+            for line, typ in zip(lines, structure):
+                stripped = line.strip()
+                k, v = stripped.split("=")
+                if typ == 0:
+                    trace[-1][k] = v
+                elif typ == 1:
+                    trace[-1][k] = {"type": v, "items": {}}
+                    trace.append(trace[-1][k]["items"])
+                elif typ < 0:
+                    trace[-1][k] = v
+                    for _ in range(-1 * typ):
+                        trace.pop()
+                else:
+                    raise PVSystFileError(f"invalid structure at {line}")
+    except UnicodeDecodeError:
+        raise PVSystFileError(f"File not utf-8 encoded. Please encode the file to utf-8 and try again")
+    return blob
+
+
+class PVSystFileError(ValueError):
+    pass
+
+
+def pv_module_from_pan(pan_file: str, bifacial_ground_clearance_height=1.0, bifacial_transmission_factor:float = 0.013):
+    pan_blob = read_pvsyst_file(pan_file)
+    data = pan_blob["PVObject_"]["items"]
+    commercial = data["PVObject_Commercial"]["items"]
+    if "PVObject_IAM" in data:
+        iam_points = [
+            v.split(",")
+            for k, v in data["PVObject_IAM"]["items"]["IAMProfile"]["items"].items()
+            if k.startswith("Point_")
+        ]
+        iam_angles = [float(v[0]) for v in iam_points]
+        iam_values = [float(v[1]) for v in iam_points]
+    else:
+        iam_angles = None
+        iam_values = None
+    return PVModuleMermoudLejeune(
+        bifacial="BifacialityFactor" in data,
+        bifacial_transmission_factor=bifacial_transmission_factor,
+        bifaciality=float(data.get("BifacialityFactor", 0.65)),
+        bifacial_ground_clearance_height=bifacial_ground_clearance_height,
+        n_parallel=int(data["NCelP"]),
+        n_diodes=int(data["NDiode"]),
+        n_series=int(data["NCelS"]),
+        t_ref=float(data["TRef"]),
+        s_ref=float(data["GRef"]),
+        i_sc_ref=float(data["Isc"]),
+        v_oc_ref=float(data["Voc"]),
+        i_mp_ref=float(data["Imp"]),
+        v_mp_ref=float(data["Vmp"]),
+        alpha_sc=float(data["muISC"]) * 1e-3,  # TODO: check units
+        beta_oc=float(data["muVocSpec"]) * 1e-3,
+        n_0=float(data["Gamma"]),
+        mu_n=float(data["muGamma"]),
+        r_sh_ref=float(data["RShunt"]),
+        r_s=float(data["RSerie"]),
+        r_sh_0=float(data["Rp_0"]),
+        r_sh_exp=float(data["Rp_Exp"]),
+        tech=data["Technol"],
+        length=float(commercial["Height"]),
+        width=float(commercial["Width"]),
+        # faiman cell temp model used by PVSyst
+        t_c_fa_alpha=float(data["Absorb"]),
+        # IAM
+        iam_c_cs_iam_value=iam_values,
+        iam_c_cs_inc_angle=iam_angles,
+        custom_d2_mu_tau=data.get("D2MuTau"),
+    )
+
+
+def inverter_from_ond(ond_file: str, includes_xfmr: bool = True):
+    ond = read_pvsyst_file(ond_file)
+    data = ond['PVObject_']['items']
+    converter = data['Converter']['items']
+    voltage_curve_points = [float(v) for v in converter['VNomEff'].split(',') if v]
+    if len(voltage_curve_points) != 3:
+        raise NotImplementedError('OND Inverter only accepts voltage curves of length 3')
+    temp_derate_curve = ONDTemperatureDerateCurve(
+        ambient_temp=[-300, float(converter['TPMax']), float(converter['TPNom']), float(converter['TPLim1']), float(converter['TPLimAbs'])],
+        max_ac_power=[float(converter['PMaxOUT']) * 1e3, float(converter['PMaxOUT']) * 1e3, float(converter['PNomConv']) * 1e3, float(converter['PLim1']) * 1e3, float(converter.get('PlimAbs', 0.)) * 1e3]
+    )
+    raw_power_curves = [converter[f"ProfilPIOV{i}"]['items'] for i in [1, 2, 3]]
+    power_curves = []
+    for curve in raw_power_curves:
+        points = [[float(v) for v in curve[f"Point_{i}"].split(',')] for i in range(1, int(curve["NPtsEff"]) + 1)]
+        dc, ac = zip(*points)
+        power_curves.append(ONDEfficiencyCurve(dc_power=dc, ac_power=ac))
+    aux_loss = data.get('Aux_Loss')
+    aux_loss_threshold = data.get('Aux_Thresh')
+    if aux_loss is not None:
+        aux_loss = float(aux_loss)
+        aux_loss_threshold = float(aux_loss_threshold)
+    return ONDInverter(
+        mppt_low=float(converter['VMppMin']),
+        mppt_high=float(converter['VMPPMax']),
+        paco=float(converter['PMaxOUT']) * 1e3,
+        vdco=voltage_curve_points[1],
+        temp_derate_curve=temp_derate_curve,
+        nominal_voltages=voltage_curve_points,
+        power_curves=power_curves,
+        dc_turn_on=float(converter['PSeuil']),
+        pnt=float(data['Night_Loss']),
+        aux_loss=aux_loss,
+        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.2.3 → tyba_client-0.2.4}/tyba_client/models.py

@@ -1,11 +1,10 @@
 from __future__ import annotations
 from dataclasses import dataclass, field
 from enum import Enum
-from io import StringIO
 from dataclasses_json import config, dataclass_json
 import pandas as pd
 import typing as t
-from .utils import read_pvsyst_file
+from .io import read_pvsyst_file, psm_column_map
 
 from tyba_client.utils import string_enum
 
@@ -347,7 +346,7 @@ class SolarResource(object):
             _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_data_map)
+        data = _data.rename(columns=psm_column_map)
         return cls(
             latitude=float(meta["Latitude"]),
             longitude=float(meta["Longitude"]),
@@ -357,29 +356,6 @@ class SolarResource(object):
         )
 
 
-_psm_data_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",
-}
-
-
 @string_enum
 class ArrayDegradationMode(str, Enum):
     linear = "linear"

tyba_client-0.2.4/tyba_client/utils.py

@@ -0,0 +1,29 @@
+from enum import Enum
+import typing as t
+
+from marshmallow import fields
+
+T = t.TypeVar('T', bound=Enum)
+def string_enum(cls: t.Type[T]) -> t.Type[T]:
+    """
+    decorator to allow Enums to be used with dataclass_json
+    Stolen from:
+    https://github.com/lidatong/dataclasses-json/issues/101#issuecomment-506418278""
+    """
+    class EnumField(fields.Field):
+        def _serialize(self, value, attr, obj, **kwargs):
+            return value.name
+
+        def _deserialize(self, value, attr, data, **kwargs):
+            return cls[value]
+    if (not hasattr(cls, '__metadata__')):
+        setattr(cls, '__metadata__', dict())
+
+    metadata = {
+        "dataclasses_json": {
+            "encoder": lambda v: v.name,
+            "decoder": lambda name: cls[name],
+            "mm_field": EnumField(),
+        }}
+    cls.__metadata__.update(metadata)
+    return cls

tyba_client-0.2.3/PKG-INFO

@@ -1,24 +0,0 @@
-Metadata-Version: 2.1
-Name: tyba-client
-Version: 0.2.3
-Summary: A Python API client for the Tyba Public API
-License: MIT
-Author: Tyler Nisonoff
-Author-email: tyler@tybaenergy.com
-Requires-Python: >=3.8,<4.0
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Requires-Dist: dataclasses-json (>=0.5.4,<0.6.0)
-Requires-Dist: generation-models (>=0.2.0,<0.3.0)
-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)
-Description-Content-Type: text/markdown
-
-# Tyba API Client

tyba_client-0.2.3/README.md

@@ -1 +0,0 @@
-# Tyba API Client

tyba_client-0.2.3/setup.py

@@ -1,36 +0,0 @@
-# -*- coding: utf-8 -*-
-from setuptools import setup
-
-packages = \
-['tyba_client']
-
-package_data = \
-{'': ['*']}
-
-install_requires = \
-['dataclasses-json>=0.5.4,<0.6.0',
- 'generation-models>=0.2.0,<0.3.0',
- 'marshmallow>=3.12.1,<4.0.0',
- 'pandas>=1.3.2,<2.0.0',
- 'requests>=2.25.1,<3.0.0',
- 'structlog>=23.1.0,<24.0.0',
- 'tyba-financial-model>=0.1.0,<0.2.0']
-
-setup_kwargs = {
-    'name': 'tyba-client',
-    'version': '0.2.3',
-    'description': 'A Python API client for the Tyba Public API',
-    'long_description': '# Tyba API Client',
-    'author': 'Tyler Nisonoff',
-    'author_email': 'tyler@tybaenergy.com',
-    'maintainer': 'None',
-    'maintainer_email': 'None',
-    'url': 'None',
-    'packages': packages,
-    'package_data': package_data,
-    'install_requires': install_requires,
-    'python_requires': '>=3.8,<4.0',
-}
-
-
-setup(**setup_kwargs)

tyba_client-0.2.3/tyba_client/utils.py

@@ -1,61 +0,0 @@
-from enum import Enum
-import typing as t
-
-from marshmallow import fields
-
-T = t.TypeVar('T', bound=Enum)
-def string_enum(cls: t.Type[T]) -> t.Type[T]:
-    """
-    decorator to allow Enums to be used with dataclass_json
-    Stolen from:
-    https://github.com/lidatong/dataclasses-json/issues/101#issuecomment-506418278""
-    """
-    class EnumField(fields.Field):
-        def _serialize(self, value, attr, obj, **kwargs):
-            return value.name
-
-        def _deserialize(self, value, attr, data, **kwargs):
-            return cls[value]
-    if (not hasattr(cls, '__metadata__')):
-        setattr(cls, '__metadata__', dict())
-
-    metadata = {
-        "dataclasses_json": {
-            "encoder": lambda v: v.name,
-            "decoder": lambda name: cls[name],
-            "mm_field": EnumField(),
-        }}
-    cls.__metadata__.update(metadata)
-    return cls
-
-
-class PVSystFileError(ValueError):
-    pass
-
-
-def read_pvsyst_file(path: str) -> dict:
-    with open(path, "r", encoding="utf-8-sig") as f:
-        blob = {}
-        trace = [blob]
-        lines = [line for line in f.readlines() if "=" in line]
-        indentations = [len(line) - len(line.lstrip()) for line in lines]
-        for indentation, line in zip(indentations, lines):
-            if divmod(indentation, 2)[1] != 0:
-                raise PVSystFileError(f"invalid indentation at {line}")
-        structure = [(y - x) // 2 for x, y in zip(indentations[:-1], indentations[1:])]
-        structure.append(0)
-        for line, typ in zip(lines, structure):
-            stripped = line.strip()
-            k, v = stripped.split("=")
-            if typ == 0:
-                trace[-1][k] = v
-            elif typ == 1:
-                trace[-1][k] = {"type": v, "items": {}}
-                trace.append(trace[-1][k]["items"])
-            elif typ < 0:
-                trace[-1][k] = v
-                for _ in range(-1 * typ):
-                    trace.pop()
-            else:
-                raise PVSystFileError(f"invalid structure at {line}")
-    return blob