plantpredict-python
latest
  • Installation & Setup
  • API Authentication
  • SDK Reference
  • Example Usage
  • Release Notes
plantpredict-python
  • Docs »
  • Python SDK for PlantPredict API
  • Edit on GitHub

Python SDK for PlantPredict API¶

PlantPredict is a web-based, utility-scale energy prediction software package. This Python software development kit provides a library to access the full functionality of PlantPredict via its API.

Full documentation on the backend algorithms used in PlantPredict is available here.

The source code for plantpredict-python is available on GitHub.

Contents¶

  • Installation & Setup
    • Setup Guide Using the Anaconda Distribution (Recommended)
    • Basic Installation
  • API Authentication
    • Step 1: Generate/receive client credentials.
    • Step 2: Store your API credentials securely.
    • Step 3: Authenticate and receive a token.
  • SDK Reference
    • Classes
    • Helpers
    • Data Enumerations
  • Example Usage
    • Create Project and Prediction from scratch.
    • Model System-Level of Power Plant (Transformer, Transmission, etc.)
    • Download nodal data.
    • Clone a prediction.
    • Change the module in a power plant.
    • Change a prediction’s weather file.
    • Upload raw weather data.
    • Generate a module file.
    • Set a prediction’s monthly factors (albedo, soiling loss, spectral loss).
  • Release Notes

Indices and tables¶

  • Index
  • Search Page
Next

© Copyright 2021, Terabase Energy Revision 8a9bcc0a.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions
latest
stable
releases-1.0.0
releases-0.9.4
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.