Overview


The Tyba API & Data Client provides programmatic access to many of the modeling capabilities available in the Tyba Web-App. Through the API, we provide endpoints for accessing models and computing resources. With the client, we create structure to the inputs & outputs of the models to make it easier to incorporate them into your workflow. In addition, the intention is for each of these models to be modular to support both detailed and simplified specification of parameters.

Please do not hesitate to reach out with any questions or suggestions to improve this documentation. Happy coding!

Documentation


Technical Reference

Client Installation

Getting Started

HTTP Response Codes

Schedule & Receiving Responses

Response Status

Rate Limit

Models

Object Hierarchy

PV Models

PV & Storage Models

Storage Models

Prices

Example Scripts & Notebooks


  1. PV-Only run

    pv_example.py

    example-tgy.csv

  2. PV-Only with PAN File

    mermoud_pv_example.ipynb

    mermoud_pv_example.py

    example_pan_file

  3. PV+Storage run - with OND File

    pv-storage-example-ond.ipynb

  4. PV+Storage run - Energy-only

    pv_storage_example.py

    pv-storage-example.ipynb

  5. PV+Storage run - Energy & Ancillary Services

    pv-storage-ancillary.ipynb

    pv_storage_ancillary_example.py

    ancillary_util.py

    pv-storage-complex-losses.ipynb

  6. PV + Storage run - Using External Generation

    external_generation.py

    external-gen-example.ipynb

  7. Standalone Storage run - Energy-only

    energy_only_storage_example.py

    energy-only-storage-example.ipynb

  8. Standalone Storage run - Energy & Ancillary Services

    coopt-storage-example.ipynb

  9. Prices

    prices_example.py

    price-example.ipynb