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.
  • Download Specific Nodal Data Outputs.
  • Get Prediction Result Summary.
  • Clone a prediction.
  • Change the module in a power plant.
  • Change a prediction’s weather file.
  • Change the status of a prediction, weather, module, inverter object.
  • Upload raw weather data.
  • Generate a module file.
  • Set a prediction’s monthly factors (albedo, soiling loss, spectral loss).
  • Upload a module .PAN file.
  • Upload an inverter .OND file.
• Release Notes

Indices and tables

• Index
• Search Page