Getting Started

This page will help you get up and running with the Python Client.

Run a Simulation

In order to use the Client, you must have a Tyba PAT (Personal Access Token). The Authentication section below explains how to store your PAT in your local environment. With the PAT stored, we can run our first simulation and view the results:

  1. Make the necessary imports:

    import os
    from generation_models import PVGenerationModel, SingleAxisTracking
    from tyba_client.client import Client
  2. Define a simple model:

    model = PVGenerationModel(
       solar_resource=(40.6685396, -73.9345585),
       inverter="Delta Electronics: M80U_XXX [480V]",
       pv_module="Boviet Solar Technology Co._ Ltd. BVM6612M-315",
  3. Read the PAT from the environment and instantiate a client

    PAT = os.environ["TYBA_PAT"]
    client = Client(PAT)
  4. Schedule the model run:

    res = client.schedule(model)
    id_ = res.json()["id"]

    You will see an id print, confirming that the run has been scheduled.

  5. Wait to receive the results:

    results = client.wait_on_result(id_)

    For more details on the schedule & receive process, see Scheduling and Receiving Responses.

  6. View results

    # Results is a dictionary. To review keys:
    # Review System Power 8760


  • The Usage page digs a bit deeper into the mechanics of the Client and its models

  • More complex examples can be found on the Examples page

  • For info on specific model objects/parameters, check out the generation_models documentation

  • For info on options within the Client, check out the Client API page


As mentioned above, you must have a Tyba PAT to use the Client. If you do not have or know your PAT, please contact us.

Mac or Linux instructions

Shell Environment (preferred)

Save your Tyba PAT in the shell’s environment:

  1. Add TYBA_PAT="your-pat-in-quotes" to a new line in ~/.bashrc

  2. To check, open a new shell/terminal and run env and confirm TYBA_PAT is present and properly set

This approach is preferred even if you are running a Jupyter notebook because it keeps the PAT from being exposed if the notebook/script is shared

Jupyter Notebook

Save your Tyba PAT in the notebook’s environment:

  1. In a notebook cell, enter the following:
    %env TYBA_PAT=your_pat_without_quotes
  2. The cell will return your key with “env: TYBA_PAT = your_pat_without_quotes”

  3. To keep the PAT secure, delete the previous cell. You will need to repeat this process each time you open the notebook

Windows Instructions

Shell Environment

On a Windows machine, the simplest (but less secure) approach is to hardcode the PAT directly into your script, i.e. replace PAT = os.environ["TYBA_PAT"] with PAT="your-pat-in-quotes"

Jupyter Notebook (preferred)

See the Jupyter notebook section above.